docs: scaffold Best Practices section#50
Open
qiansheng91 wants to merge 1 commit into
Open
Conversation
Reserve a Best Practices section on the docs site, wired into nav + sidebar in both locales. Establishes the one-practice-per-page convention (title → one-line statement → Why → Do/Don't → See also) with an index hub grouped by Modeling / Querying / Agent integration, and one seed practice (stable-identity) as a template. Further practices are filled in over time.
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
1 participant
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.
What
Scaffolds a Best Practices section on the docs site — the place is reserved and wired in; practices get filled in over time.
docs/{en,zh}/best-practices/— bilingual section with an index hub establishing the one-practice-per-page convention (title → one-line statement → Why → Do/Don't → See also).stable-identity(use stable, domain-scoped identity) — as a working template to copy. Cross-links existing guides; no new prose duplicated.Adding a practice later = drop a page in
best-practices/and link it from the index + sidebar.Note
The nav/sidebar edits in
config/en.ts+config/zh.tsoverlap with #48 (schema reference). Whichever merges second will need a trivial conflict resolution (both just add a section to the same arrays).Verification
pnpm -C docs buildclean — 0 dead links;best-practices/pages render in both locales; no{{ }}leakage.