Repository navigation
docs: reorganise the docs around what a user is doing and rewrite pages that bury their point - #1435
Merged
Merged
Conversation
…n pages with the normal path
…ability and scope pages
…bservability pages
… detail, and regenerate the docs skill
…rename-detection wording
…ges for check_declared_columns
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docs put reference material in a new user's path: a 5,900-word configuration page, a naming spec and five overlapping rename pages come before models and tests. Several pages open with edge cases before the main point. This reorganises the site around what a user is doing and rewrites the pages that bury their message.
Changes
sqb <command>titles).check_declared_columnsas one sentence, a runtime table per materialization, upstream contracts), Reusable column schemas, Naming rules, Column and model migrations,sqb rename, Observability, Quickstart (adds a "Change a model" step).sqb build, migration-origin policy to Model migrations.Verification
npm run buildandscripts/check_links.py dist: 129 pages, 0 broken links.npm test(Playwright) passes.scripts.generate_docs_skillandscripts.check_docs_skillare up to date.