Repository navigation
docs: lead the site and docs with agentic coding and the Storm CLI - #666
Merged
Merged
Conversation
Homepage: the hero names agentic coding and performance, the editor opens on a `storm init` terminal scene with a copy control, and a new section explains why the model suits coding agents and how the CLI sets one up (local, read-only MCP server; existing rules files keep their content). Quickstart, comparison and templates pages point coding-agent users to `npx @storm-orm/cli init` and `demo`. Navbars and footers link the guide, and the custom navbars collapse to the menu below 1000px so the links no longer overlap the brand. Docs: the AI guide becomes "Agentic Coding", opens with why Storm suits agents, documents `demo` and the global install, and moves with its reference pages into a top-level sidebar group. Set Up Your Project leads with the coding-agent route. README follows the same structure. Agent-readable docs: llms.txt lists the agent pages, and every docs page is published as Markdown at /docs/<page>.md (latest release) and /docs/next/<page>.md, generated at prebuild and not committed.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| // A "$ <command>" chip that copies the command on click. The whole chip is the | ||
| // button, so the target is large on phones and a keyboard reaches it directly. | ||
| const cliChip = (command) => | ||
| `<button type="button" class="clichip" data-copy="${esc(command)}" aria-label="Copy command: ${esc(command)}">` + |
| // A "$ <command>" chip that copies the command on click. The whole chip is the | ||
| // button, so the target is large on phones and a keyboard reaches it directly. | ||
| const cliChip = (command) => | ||
| `<button type="button" class="clichip" data-copy="${esc(command)}" aria-label="Copy command: ${esc(command)}">` + |
| <span class="dot r"></span><span class="dot y"></span><span class="dot g"></span> | ||
| <span class="fname" id="fname">Entities.kt</span> | ||
| <button type="button" class="sqlbtn" id="sqlbtn" aria-expanded="false" aria-controls="sqlpanel" style="display:none"><svg class="ico" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><ellipse cx="12" cy="5" rx="8" ry="3"/><path d="M4 5v14c0 1.7 3.6 3 8 3s8-1.3 8-3V5"/><path d="M4 12c0 1.7 3.6 3 8 3s8-1.3 8-3"/></svg><span id="sqlbtntext">Show SQL</span></button> | ||
| <button type="button" class="sqlbtn clicopy" id="copybtn" data-copy="${esc(CLI_INIT)}" aria-label="Copy command: ${esc(CLI_INIT)}"><svg class="ico" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><rect x="9" y="9" width="12" height="12" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg><span class="cptext">Copy command</span></button> |
| <span class="dot r"></span><span class="dot y"></span><span class="dot g"></span> | ||
| <span class="fname" id="fname">Entities.kt</span> | ||
| <button type="button" class="sqlbtn" id="sqlbtn" aria-expanded="false" aria-controls="sqlpanel" style="display:none"><svg class="ico" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><ellipse cx="12" cy="5" rx="8" ry="3"/><path d="M4 5v14c0 1.7 3.6 3 8 3s8-1.3 8-3V5"/><path d="M4 12c0 1.7 3.6 3 8 3s8-1.3 8-3"/></svg><span id="sqlbtntext">Show SQL</span></button> | ||
| <button type="button" class="sqlbtn clicopy" id="copybtn" data-copy="${esc(CLI_INIT)}" aria-label="Copy command: ${esc(CLI_INIT)}"><svg class="ico" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><rect x="9" y="9" width="12" height="12" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg><span class="cptext">Copy command</span></button> |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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
Makes agentic coding and the Storm CLI a first-class path through the website, the docs and the README.
Homepage
1 · agent setupscene:npx @storm-orm/cli inittypes, then its output prints line by line, following what the CLI prints (including the read-only data-access prompt and an existingCLAUDE.mdreported as updated, not overwritten). A "Copy command" control sits in the editor bar for this scene.Copy CLI command(a matching goal must be added in the dashboard to report it).Other pages
initanddemo; the mid-step CLI block is removed.npx @storm-orm/cli initafter "Use this template".Docs (
docs/, visible at/docs/nextuntil the next release)ai.mdbecomes "Agentic Coding": opens with why Storm suits agents, leads setup withnpx, documentsstorm demoand when to install globally, and states that existing rules files keep their content.Agent-readable docs
llms.txtheader rewritten and a "Working with a coding agent" section added (the agent pages were missing from its list)./docs/<page>.mdfrom the latest release snapshot,/docs/next/<page>.mdfromdocs/. Generated by the prebuild script, gitignored, version placeholders filled at postBuild.README
Verification
npm run buildsucceeds;scripts/check-links.mjs: no broken links (969 pages).