docs: add Best Practices unversioned page#598
Merged
nicoloboschi merged 10 commits intomainfrom Mar 17, 2026
Merged
Conversation
- Merge Clients and Integrations sections into the developer sidebar (removed top-level SDKs navbar item) - Reorder sidebar: Architecture → API → Clients → Integrations → Hosting - Unify icon system using react-icons (LuXxx/SiXxx) via customProps.icon - Add uppercase section titles with increased spacing and reduced indentation - Rename Node.js → "JavaScript / TypeScript" with TypeScript icon - Add reusable IconGrid and SupportedGrids components (ClientsGrid, IntegrationsGrid, LLMProvidersGrid) - Use grids in FAQ, Models, Overview, and Quick Start pages - Convert developer/index.md, models.md, faq.md to MDX for JSX support
- Add src/pages/best-practices.mdx covering core concepts (memory banks, taxonomy, memory types), bank configuration (missions, dispositions, entity labels), retain (formats, context, document_id, tags, observation scopes), recall (budget, tag filtering, include options), reflect (recall vs reflect decision, response_schema, auditing), mental models, and anti-patterns - Add Resources section to sidebar with Best Practices and FAQ links - Update generate-docs-skill.sh to include standalone pages (best-practices, faq) from src/pages/ into the agent skill references - SKILL.md now surfaces best-practices.md as the recommended starting point
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.
Summary
src/pages/best-practices.mdxas a standalone (unversioned) page alongside FAQ, covering the full integration lifecycle: core concepts, bank configuration, retain, recall, reflect, mental models, and anti-patternsgenerate-docs-skill.shto pull standalone pages (best-practices,faq) fromsrc/pages/into the agent skill references —best-practices.mdis surfaced as the recommended starting point inSKILL.mdTest plan
/best-practices./scripts/generate-docs-skill.shproducesreferences/best-practices.mdandreferences/faq.mdat skill root