docs: add comprehensive Getting Started guide (Phase 2)#21
docs: add comprehensive Getting Started guide (Phase 2)#21AWaterColorPen wants to merge 3 commits intomainfrom
Conversation
AWaterColorPen
left a comment
AWaterColorPen
left a comment
There was a problem hiding this comment.
The guide itself is well-structured — SQLite-first examples lower the barrier nicely and the four-concept table gives readers a solid mental model.
One hard blocker: three of the new README table entries link to files that do not exist yet:
| Link in README | Status |
|---|---|
docs/examples.md |
❌ 404 |
docs/architecture.md |
❌ 404 |
CONTRIBUTING.md |
❌ 404 |
Merging with dead links will confuse the first users who follow them. Options:
- Add stub files (even one-paragraph placeholders) in this PR — preferred.
- Remove the three broken rows from the README table and add them back when the files are ready.
Everything inside docs/getting-started.md looks good. The internal cross-links (configuration.md, query.md, result.md) all resolve correctly. Ready to approve once the broken links are resolved.
| | Document | Description | | ||
| |----------|-------------| | ||
| | [Getting Started](./docs/getting-started.md) | Step-by-step guide to your first query | | ||
| | [Configuration](./docs/configuration.md) | Configure Manager, clients, and the OLAP dictionary | |
There was a problem hiding this comment.
docs/examples.md does not exist in the repo — this link will 404. Please either add a stub file in this PR or remove the row until the file is ready.
There was a problem hiding this comment.
Added docs/examples.md as a stub file (commit 5781eab). It acknowledges the placeholder status and lists what will be covered in a follow-up PR. The link is now live.
| |----------|-------------| | ||
| | [Getting Started](./docs/getting-started.md) | Step-by-step guide to your first query | | ||
| | [Configuration](./docs/configuration.md) | Configure Manager, clients, and the OLAP dictionary | | ||
| | [Query](./docs/query.md) | Define metrics, dimensions, filters, orders, and limits | |
There was a problem hiding this comment.
docs/architecture.md does not exist. Same as above — stub or remove.
There was a problem hiding this comment.
Added docs/architecture.md as a stub file (commit 5781eab). It includes a high-level component table and a "Coming soon" section for the deeper content. Link resolves now.
| | [Getting Started](./docs/getting-started.md) | Step-by-step guide to your first query | | ||
| | [Configuration](./docs/configuration.md) | Configure Manager, clients, and the OLAP dictionary | | ||
| | [Query](./docs/query.md) | Define metrics, dimensions, filters, orders, and limits | | ||
| | [Result](./docs/result.md) | Parse and work with query results | |
There was a problem hiding this comment.
CONTRIBUTING.md does not exist. Same as above — stub or remove.
There was a problem hiding this comment.
Added CONTRIBUTING.md at repo root as a stub file (commit 5781eab). Covers fork/branch/test/PR basics and flags a "Coming soon" section for deeper guidance. Link resolves now.
Addresses review comments on PR #21 — the three links in the getting-started.md 'What's next' table were pointing to files that didn't exist yet. Added minimal placeholder stubs so the links resolve; full content will follow in subsequent PRs.
|
AI Review (automated) — all previous blockers resolved ✅ The three broken links flagged in the earlier review are now addressed in commit 5781eab:
All stubs include honest "Work in progress" callouts and "Coming soon" sections, so readers are not left stranded.
This PR is ready to merge. |
1 participant
Phase 2 — Getting Started Guide
This PR adds
docs/getting-started.md, a step-by-step guide for new users.What's included
ManagerwithClientsOptionandDictionaryOption; tips on multiple DB connectionsBuildSQLfor inspecting generated SQL before running (debugging)RunSyncvsRunChan(streaming for large result sets)Result.DimensionsandResult.Source, with a JSON output exampleAlso updates README to link to this new guide and previews upcoming Phase 2 docs.
Part of
Phase 2: Documentation — spec