Conversation
The user guides in docs/user were only readable on GitHub. The marketing site now renders them with Astro Starlight under /docs, loading the files in place so GitHub and the site share one source. - Pages carry a frontmatter title instead of an H1. - A Sätteri link plugin rewrites ./page.md links to site routes. - docs/user/README.md is the /docs landing page. - Starlight's 404 route is disabled so the rest of the site is unchanged. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The docs used Starlight's stock chrome: its own header, a light/dark picker, filled sidebar pills, and default code frames. Swap those for the marketing site's pieces: the T3 Code / Docs wordmark, the Download link and GitHub stars pill, the zinc palette and hairline borders, the hero grid behind page titles, terminal-window code blocks, and a dark-only theme. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Starlight's header grid lines the search box up with the content column, which left it stuck at the left of the header. Replace the header with a plain row like the marketing nav: the wordmark on the left, and search leading Download and the GitHub stars pill on the right. On mobile the search button is now the same circle as the menu button. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Sidebar, table of contents, and search text used zinc-500 (#71717a), which is 4.1:1 on the page background. #80808a clears 4.5:1 on both the page background and gray-6 panels. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
| <span class="nav-brand-name">T3 Code</span> | ||
| </a> | ||
| <div class="nav-right"> | ||
| <a class="nav-link" href="/docs/">Docs</a> |
There was a problem hiding this comment.
🟡 Medium layouts/Layout.astro:83
The added Docs link makes the non-wrapping mobile header wider than a 390px viewport, so the right side of the navigation—including the new link—is clipped and unreachable. Remove this header item (the footer still provides a Docs link), or hide it at phone widths.
- <a class="nav-link" href="/docs/">Docs</a>🤖 Copy this AI Prompt to have your agent fix this:
In file @apps/marketing/src/layouts/Layout.astro around line 83:
The added `Docs` link makes the non-wrapping mobile header wider than a 390px viewport, so the right side of the navigation—including the new link—is clipped and unreachable. Remove this header item (the footer still provides a `Docs` link), or hide it at phone widths.
ApprovabilityVerdict: Not approved Macroscope's review found this PR not approvable — This PR adds a substantial production-facing docs site, including new routing, search, components, styling, and build dependencies rather than merely editing documentation. An unresolved Medium-severity finding also identifies clipped mobile navigation caused by the new marketing header link. Not approved because:
Adjust the Minimum Blocking Severity for this repo — including turning it Off — in Settings. You can add or adjust custom eligibility rules. Learn more. |
The Docs link crowded the homepage nav on phones: the wordmark wrapped onto two lines at 390-428px, and the nav overflowed at 360px and below. Hide it up to 440px so the 428px Pro Max is covered. The footer still links to the docs. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
|
idk. if someone reads docs these days themselves. I ask my claude code to install t3 code lol |
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: pingdotgg/t3code/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (42)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe marketing app now publishes user guides through Starlight. It loads Markdown files from ChangesUser documentation site
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Feature Sequence Diagram(s)sequenceDiagram
participant DocsMarkdown as docs/user Markdown
participant DocsCollection as Astro docs collection
participant docsEntryId
participant SatteriPlugin as t3-docs-links plugin
participant docsHref
participant Starlight
DocsCollection->>DocsMarkdown: Load Markdown files
DocsCollection->>docsEntryId: Generate route IDs
SatteriPlugin->>docsHref: Resolve relative Markdown URLs
docsHref-->>SatteriPlugin: Return rewritten route or original URL
DocsCollection->>Starlight: Provide docs entries validated with docsSchema
Suggested reviewers: Merge Risk: ⚪ Minimal · up to No concrete issue with the published guides or documentation site is established; the PR appears ready for normal merge checks. Security Architecture ReviewSecurity architecture risk: 🔵 Low · up to The new pages publish guides through the existing marketing site. The reviewed changes do not establish a new privileged endpoint or a verified security issue, but the additional public rendering surface warrants review. Retained concerns Security review detailsSecurity Blast Radius
Trust Boundaries and Controls
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
The user guides in
docs/usercould only be read on GitHub, and the README said there was no docs site.This adds Astro Starlight to the existing marketing site, so the guides are served at
t3.codes/docswith search, a sidebar, and a table of contents on each page. It deploys with the marketing site, so there's no new app or Vercel project.How it works
apps/marketing/src/content.config.tsreadsdocs/user/*.mdfrom where they already live, so GitHub and the site render the same files.# H1is now a frontmattertitle, which Starlight requires../page.md#anchor, which works on GitHub. A small Sätteri link plugin (Astro 7's default markdown engine) rewrites those links to/docs/page/#anchoron the site. Heading anchors use the same slugger as GitHub, so existing#anchorsresolve.docs/user/README.mdbecomes/docs. It's also what GitHub shows when you open thedocs/userfolder.apps/marketing/astro.config.mjs.docs/README.mdnow points there instead of keeping a second list./docspages.apps/marketing/src/components/docs/andsrc/styles/docs.cssreplace Starlight's stock look with the site's:T3 Code / Docswordmark on the left, with search, the Download link, and the GitHub stars pill grouped on the right of the header;AGENTS.mdcovering the three rules for new user docs: frontmatter title,./page.mdlinks, and a sidebar entry.Screenshots
Before:
t3.codes/docsdoesn't exist. The guides are only on GitHub.After:
/docs/docs/install/Mobile (iPhone 12 Pro)
Homepage nav with the new Docs link:
Verification
vp run buildinapps/marketingbuilds all 27 doc pages plus the Pagefind search index. The only warning is Starlight's standard "i18n collection is empty"./docs/..., anchors match, and the homepage loads no Starlight CSS.vp test run src/lib/docsLinks.test.tsandastro checkpass. Lint, format, and knip are clean for the changed files.astro previewon desktop and an iPhone 12 Pro viewport: search, sidebar, table of contents, tables, code blocks, and the mobile menu.Replaces #13420, which was closed only to move this work to a better-named branch. Its CodeRabbit contrast finding is fixed here.
🤖 Generated with Claude Code (Claude Opus 5.5, running in T3 Code)
Summary by CodeRabbit