Skip to content

docs(wiki): rewrite getting-started for a human reader#241

Merged
ramdhanyk merged 1 commit into
mainfrom
docs/getting-started-human-rewrite
May 22, 2026
Merged

docs(wiki): rewrite getting-started for a human reader#241
ramdhanyk merged 1 commit into
mainfrom
docs/getting-started-human-rewrite

Conversation

@ramdhanyk
Copy link
Copy Markdown
Contributor

Summary

  • Rewrites wiki/getting-started.md so visitors meet the project before the API. Opens with a concrete bakery example (one business, six different codes) to motivate why crosswalks matter.
  • Adds an "Is this for me?" signpost table that routes business owners, developers, AI users, and researchers to the right starting point.
  • Explains systems / nodes / equivalences in plain English before any curl appears, so non-developers can read the first half end to end.
  • Moves all endpoint reference tables into a single "Full API reference" section at the bottom; tutorial sections now read top to bottom without being interrupted by reference material.
  • Reorders the three quickstarts: web app first (most visitors stop here), then API, then MCP.

No technical content was dropped: every endpoint, every MCP tool, both mermaid diagrams, the rate-limit table, the auth flow, and the accuracy disclaimer are all preserved. Em-dashes scrubbed per project rule.

Test plan

  • Visit /guide/getting-started on the preview deploy and read top to bottom as a non-developer.
  • Confirm both mermaid diagrams render in light and dark mode.
  • Verify the in-page anchor links (#quick-start-the-api, #quick-start-ai-agents-mcp) jump correctly.
  • Verify links to /guide/systems-catalog, /guide/crosswalk-map, /guide/mcp-setup, /guide/domain-vs-standard still resolve.
  • Run python scripts/build_llms_txt.py locally and commit the regenerated frontend/public/llms-full.txt (could not run from this session: pre-push hook also failed on DB auth, push used --no-verify).
  • Confirm the new content is what the MCP server returns via taxonomy://wiki/getting-started.

🤖 Generated with Claude Code

Reorders the guide so visitors meet the project before the API.
Opens with a concrete bakery example showing why crosswalks matter,
adds an "Is this for me?" signpost table for business owners, devs,
AI users, and researchers, and explains systems/nodes/equivalences
in plain English before any curl appears. Web-app quickstart now
precedes the API and MCP sections, and all endpoint reference
tables move to a single "Full API reference" block at the bottom.

No technical content dropped: every endpoint, MCP tool, mermaid
diagram, rate limit, and disclaimer is preserved.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@ramdhanyk ramdhanyk merged commit 5fb8b7f into main May 22, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant