User guide at /docs with Fumadocs - #41
Merged
Merged
Conversation
A user guide next to the product page, in the same Next.js app and deploy: setup, the GitHub token (permissions per feature, SAML single sign-on and why pull requests from such an organization silently go missing), inbox, review, merging, stacks, keyboard shortcuts, every Settings pane, AI and language models, automation, privacy and troubleshooting. Every page was written from the current code, with UI labels quoted from the English strings. The product page and the guide get separate root layouts, so the guide's Tailwind never reaches the product page. /llms.txt, /llms-full.txt and per-page Markdown serve the guide to language models; search runs on Fumadocs' built-in index. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Stk21d93DeKQXioFaZpWGm
Review: the token page now says settings sync keeps an encrypted copy of the token, and fixes wording about retries, merge-when-green, stack outcomes, the session keys, Settings labels and Load models. /llms.mdx only answers for content.md. Simplify: search is a static index built at build time, searched in the browser, instead of a function per query. The scaffold's mdx components file, default-valued loader options and the unused `full` prop are gone; the Markdown URL has one helper; the phone-width nav rule hangs on a class, not on the first link's position. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Stk21d93DeKQXioFaZpWGm
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.
A user guide on shepherd.schnaq.com/docs, built with Fumadocs inside the existing Next.js site: same app, same Vercel deploy.
Pages: overview, installation, GitHub token (permissions per feature, SAML SSO and why such an org's pull requests silently go missing), inbox, review, merging (series, merge when checks pass), stacks, keyboard shortcuts, every Settings pane, AI and language models, automation (agents,
shepherd://, CLI, Shortcuts, webhooks), privacy, troubleshooting. Written from the current code; UI labels are the English strings.Framework:
app/(site)andapp/(docs)are separate root layouts, so the guide's Tailwind never reaches the product page. The product page renders unchanged; its nav gains a Docs link./llms.txt,/llms-full.txtand per-page Markdown serve the guide to language models.Checked: a clean install, typecheck and build, every internal link and anchor, search in a browser, and before/after screenshots of the product page.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Stk21d93DeKQXioFaZpWGm