Skip to content

docs(build): replace the Guides tab with Build and Run - #658

Merged
aicayzer merged 2 commits into
mainfrom
docs/chunk3b-build-and-run
Oct 25, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/chunk3b-build-and-run

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Guides tab is replaced by two tabs, Build and Run. Build is for code against an instance (tutorials, building apps and agents, building connectors). Run is for an instance and its care, with no code (set up, keys and access, folders, connectors, looking after it). The tab order is now Overview, Build, Run, Catalog, Reference. Addresses move from /guides/<slug> to /build/<slug> and /run/<slug>, and /guides/... no longer exists, with no redirects.

Changes

  • Moves every page out of content/docs/guides/ with git mv: 20 pages to build/ and 19 to run/, including the Raycast tutorial.
  • Adds build/meta.json and run/meta.json (root tabs with the Hammer and Server icons) and a landing page for each: build/index.mdx (Build on Marfa) and run/index.mdx (Run Marfa), each with cards and a "Looking something up?" line.
  • Updates SECTIONS in src/components/section-nav.tsx and its test, the root meta.json, and the tests that named the Guides tab or a /guides/ address (docs-map, docs-tools, catalog, docs-structure, content-lint, docs-api, the command-check allowlist and two CI script fixtures).
  • Rewrites every /guides/<slug> link in the pages, including the Overview, Catalog and Reference landings, the glossary and the changelog.
  • Updates AGENTS.md, STYLE.md and content/AGENTS.md. A slug may not be a tab folder name (build, run, catalog).
  • Fixes a link in the quickstart whose anchor (#write-and-read-an-item) did not exist; it now points to #call-an-operation.

Testing

  • pnpm build, pnpm build:status, pnpm types:check and pnpm test (706 tests) pass; the two CI script tests pass.
  • Crawled the 449 internal links in the prerendered pages: none broken. Every anchor resolves.
  • Checked all 224 prerendered pages for the highlighted tab: each shows exactly the expected one, including API reference, Catalog connectors and the landing pages.
  • Ran vite preview on the built Worker: /build and /run answer 200, /guides/deploy answers 404, and /build.md, /run.md, /llms.txt, /docs-map.md and /api/docs/search list the new addresses. A Markdown Accept header on /run returns the Markdown copy.
  • Read each tab and landing page in the browser, light and dark, and the mobile tab switcher (five tabs with icons).
  • Not tested: the deployed Worker. run_worker_first and the prerender filter name no page address, so neither is changed.

Notes for reviewers

  • The pull request changes two files that draft docs(devices): describe fills only in place and writes held for another instance #632 also edits: content/docs/(overview)/devices.mdx (lines 14, 40 and 89) and content/docs/run/troubleshooting.mdx (20 single-line link edits, moved with git mv). Only the /guides/ addresses change.
  • The Run landing has eight cards so the grid has no gap.
  • The Folders pages sit in Run, as decided.
  • Links from other repositories to docs.marfa.so/guides are updated in separate pull requests.

Checklist

  • Follows STYLE.md
  • Content lint, command check and tests pass
  • No generated file edited
  • No private detail committed
  • Agent instructions updated where the change affects them

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: ready to merge

Summary. Replaces the Guides tab with Build and Run and moves the pages and their links. A fresh reviewer checked the new landing pages, the completeness of the move (no /guides address or "Guides tab" wording left), the sidebars, the tab bar and the 404 behavior, and that the two pages another draft edits changed only in link addresses. Small copy fixes are in the branch.

Reviewed by withmarfa-reviewer. This review may contain mistakes.

@aicayzer
aicayzer marked this pull request as ready for review October 25, 2026 18:22
@aicayzer
aicayzer merged commit 94ca015 into main Oct 25, 2026
7 checks passed
@aicayzer
aicayzer deleted the docs/chunk3b-build-and-run branch October 25, 2026 18:24
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