You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Publish the user guides at t3.codes/docs through the existing Astro site
#15081
T3 Code already has user guides for installation, permissions, multiple provider accounts, and remote access in docs/user. Reading and navigating them currently means going through GitHub. t3.codes/docs returns a 404, and the upstream README says there is no docs site yet.
#6913 raises the same discoverability problem. One commenter missed the guides because they were looking on the website. This proposal puts forward a specific approach using the existing marketing site.
Proposed approach
Publish the existing user guides at t3.codes/docs, using Astro Starlight within apps/marketing.
Read the Markdown directly from docs/user, so GitHub and the website share one source and contributors keep editing the same files.
Provide search, a grouped sidebar, and a table of contents, with navigation that works on phones as well as desktop.
Build and deploy the docs with the existing marketing site, using its current hosting setup.
Add a Docs link to the site's navigation and footer, and update the README to point to the published guides.
Match the site's existing visual style, keeping the docs styling scoped to /docs pages.
The initial scope would cover the existing user guides, a docs landing page, and the metadata and link handling needed to render those guides on both GitHub and the website. Maintainer documentation would stay in the repository.
Alternatives and tradeoffs
Starlight provides routing, navigation, and search, but it adds a dependency to the marketing build. The prototype also needed a compatible Astro version, link adaptation, and styling overrides that would need maintaining.
Rendering the guides with plain Astro would reduce the framework integration, though navigation and search would need their own implementation. Linking directly to the GitHub guides from the website would be a smaller first step if maintainers prefer that scope.
Prototype and approval
I opened PR #13573 before getting approval of the direction and scope. It was closed pending that agreement. The PR contains a prototype and desktop/mobile screenshots for context.
Would maintainers approve publishing the existing guides within the current marketing site using Starlight, with the scope above? I'm happy to adjust the approach or narrow the first version. If approved, I'd link the approval and request reconsideration of the PR, or submit a focused replacement reflecting the agreed scope.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Problem
T3 Code already has user guides for installation, permissions, multiple provider accounts, and remote access in
docs/user. Reading and navigating them currently means going through GitHub.t3.codes/docsreturns a 404, and the upstream README says there is no docs site yet.#6913 raises the same discoverability problem. One commenter missed the guides because they were looking on the website. This proposal puts forward a specific approach using the existing marketing site.
Proposed approach
Publish the existing user guides at t3.codes/docs, using Astro Starlight within
apps/marketing.docs/user, so GitHub and the website share one source and contributors keep editing the same files./docspages.The initial scope would cover the existing user guides, a docs landing page, and the metadata and link handling needed to render those guides on both GitHub and the website. Maintainer documentation would stay in the repository.
Alternatives and tradeoffs
Starlight provides routing, navigation, and search, but it adds a dependency to the marketing build. The prototype also needed a compatible Astro version, link adaptation, and styling overrides that would need maintaining.
Rendering the guides with plain Astro would reduce the framework integration, though navigation and search would need their own implementation. Linking directly to the GitHub guides from the website would be a smaller first step if maintainers prefer that scope.
Prototype and approval
I opened PR #13573 before getting approval of the direction and scope. It was closed pending that agreement. The PR contains a prototype and desktop/mobile screenshots for context.
Would maintainers approve publishing the existing guides within the current marketing site using Starlight, with the scope above? I'm happy to adjust the approach or narrow the first version. If approved, I'd link the approval and request reconsideration of the PR, or submit a focused replacement reflecting the agreed scope.
All reactions