docs: polish pass + launch-readiness pages#60
Merged
Conversation
Polish from a full review of the site: - Fix two real snippet bugs: Ollama baseUrl now includes /v1 (it speaks the OpenAI wire format), and the openai peer-dep list includes Azure. - Standardize on toolDefinition() (there is no tool() export); drop a dangling internal boost/skills reference. - Add uniform "See also" footers to the ai-sdk deep pages and the four family pages (which previously dead-ended on a License/MIT line); unify the MCP disambiguation heading and the structured-output link label. - Reword ai-autopilot from an internal-design register to user-facing voice. New pages for a launch-ready site: - guide/tutorial.md: an end-to-end "Build a Multi-Agent App" walkthrough that composes ai-sdk tools, an ai-skills SKILL.md, and an ai-autopilot Supervisor. - guide/when-to-use.md: positioning / when to reach for GemStack. - guide/contributing.md: the graduation model and how to contribute. All wired into the sidebar. docs:build is green, no dead links, no em-dashes.
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.
Follow-up polish on the docs site (#58), from a full read-through of all 18 pages.
Fixes
baseUrlnow includes/v1(it speaks the OpenAI wire format; the default is…/v1), and theopenaipeer-dep list in installation now includes Azure for parity with the providers page.toolDefinition()everywhere: the exported factory istoolDefinition()(there is notool()export); fixed the prose inguide/indexandai-skillsthat saidtool().boost/skillsinternal reference inai-skills.## License / MITline, README noise on a docs site).ai-mcpandmcp, and the structured-output link label.ai-autopilotfrom an internal-design register ("the seed", "earns its keep") to the user-facing voice used elsewhere.New pages (launch-readiness)
guide/tutorial.md— an end-to-end "Build a Multi-Agent App" walkthrough composing ai-sdk tools + an ai-skillsSKILL.md+ an ai-autopilotSupervisor. Every API verified against source.guide/when-to-use.md— positioning: when to reach for GemStack, where it stops, how it differs from a provider SDK or a heavyweight framework.guide/contributing.md— the graduation model and how to contribute.All three are wired into the sidebar.
Verification
pnpm --filter @gemstack/docs docs:buildis green, no dead links, no em-dashes. Docs-only, private package, no changeset.