docs: add /docs/agents/ section and in-flow callouts for the LLM kit#24
Open
omermorad wants to merge 1 commit into
Open
docs: add /docs/agents/ section and in-flow callouts for the LLM kit#24omermorad wants to merge 1 commit into
omermorad wants to merge 1 commit into
Conversation
New single-page guide at /docs/agents/ documents the bundled LLM kit shipped inside @suites/unit: AGENTS.md + CLAUDE.md install snippets, directory-tree map, versioning, troubleshooting. Slots into the sidebar at position 2 (renumber pushes guides and api-reference down by one). Inline pointers on installation.mdx, why-suites.md, sociable.md, and from-automock.md route readers in the funnel into the new section. static/llms.txt gets a "For AI coding agents" stanza directing crawlers at node_modules/@suites/unit/dist/llm/knowledge/. Follows the Vercel next@16.2 pattern: source of truth lives in the @suites/unit npm package; the website is the human bridge to the bundled docs.
✅ Deploy Preview for suites-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
/docs/agents/(~106 lines) documents the bundled LLM kit shipped inside@suites/unit: copy-pasteAGENTS.md+CLAUDE.mdsnippets, directory-tree map, versioning notes, troubleshooting links.installation.mdx,why-suites.md,sociable.md, andfrom-automock.mdroute funnel readers into the new section.static/llms.txtgains a "For AI coding agents" stanza directing crawlers atnode_modules/@suites/unit/dist/llm/knowledge/.guides(2→3) andapi-reference(3→4) to fit.Follows the Vercel
next@16.2pattern (seenextjs.org/docs/app/guides/ai-agents): source of truth lives in the@suites/unitnpm package, the website is the human bridge to the bundled docs.What's in
/docs/agents/index.mdxSingle MDX page, ~106 lines, six H2 sections:
AGENTS.md→node_modules/@suites/unit/dist/llm/knowledge/index.md→ task-specific file → write test).AGENTS.mdtab + marker-block contract note), Step 2 (CLAUDE.mdtab), Verify (3 bullets).node_modules/@suites/unit/dist/llm/plus a paragraph per subdirectory.The literal
AGENTS.mdblock embedded in the page is byte-identical to/Users/omer/projects/suites/suites/packages/unit/llm/templates/agents-block.mdin the kit monorepo.Test plan
yarn buildsucceeds (Docusaurus hasonBrokenLinks: "throw"so broken internal links would fail the build).yarn start→ visit/docs/agents/; sidebar shows "AI Agents" at position 2 between "Get Started" and "Testing Guides"; both<Tabs>blocks render; directory tree renders as a fencedtextblock./docs/get-started/installation/— the AI-agent paragraph sits between the package list and:::info Why reflect-metadata?. Total admonition count on the page = 4./docs/get-started/why-suites/—:::tip Set this up for your AI agentappears before the## In Summaryheading./docs/guides/sociable/— "AI agent setup" bullet appears in the Next Steps list./docs/migration-guides/from-automock/—:::tipappears between Step 1 and Step 2.## Installanchor on the new page.https://suites.dev/llms.txtincludes the new "For AI coding agents" stanza after the Netlify deploy.Out of scope
packages/unit/llm/. This PR does NOT bundle it into the website; the page references it vianode_modules/@suites/unit/dist/llm/. A build-time mirror is a separate effort.writing-unit-tests-typescriptskill repo forskills.sh.docs.nestjs.com/recipes/suites(external coordination).