feat: implement public documentation site with full content, styling, and navigation - #131
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This stack of pull requests is managed by Graphite. Learn more about stacking. |
f18b299 to
36d0825
Compare
|
@codex review |
79f8881 to
c20f236
Compare
36d0825 to
55e77cd
Compare
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 36d08256be
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| tagline: Una guía práctica para seleccionar, configurar y ampliar tu monorepo TypeScript. | ||
| actions: | ||
| - text: Comenzar | ||
| link: /es/getting-started/ |
There was a problem hiding this comment.
When a reader opens the Spanish homepage, this primary action—and the four card links below it—targets /es/... pages, but the loader has only docs/es/index.mdx; no Spanish guide or architecture entries exist, so every path lands on the custom 404 instead of the available English fallback. Link these actions to the existing English routes or add the corresponding Spanish documents.
Useful? React with 👍 / 👎.
| description: DOCS_DESCRIPTION, | ||
| disable404Route: true, | ||
| editLink: { | ||
| baseUrl: `${GITHUB_URL}/edit/main/apps/docs/`, |
There was a problem hiding this comment.
For every page loaded from root docs/, Starlight appends the content entry path to this base, producing GitHub edit URLs such as apps/docs/getting-started.md, which do not exist. Since the commit moved authored content out of apps/docs, the base should end in /docs/ so the site’s Edit page links open the actual source files.
Useful? React with 👍 / 👎.
55e77cd to
cc47394
Compare
cc47394 to
c382b1f
Compare
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c382b1f558
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| </p> | ||
| <div class="actions"> | ||
| <a class="primary" href="/">Documentation overview</a> | ||
| <a href="https://init.now">Return to init.now</a> |
There was a problem hiding this comment.
When a scaffold owner sets PUBLIC_MARKETING_URL for their deployed site, only the header wordmark uses it; this 404 action and the “Elsewhere” sidebar entry in astro.config.ts remain hardcoded to https://init.now. Readers therefore leave the scaffolded project for the upstream Init site from those navigation paths, so both links should derive from the configured marketing URL or its shared fallback.
Useful? React with 👍 / 👎.
c382b1f to
7cb12c6
Compare
7cb12c6 to
50dd2da
Compare
50dd2da to
5227ce9
Compare
1 participant
Launch public Init documentation site at docs.init.now
Turns
apps/docsinto the live Init documentation site while keeping it the inheritable Starlight example for scaffolded projects that select the docs workspace.Content architecture
Root
docs/now owns all authored Markdown and MDX. The docs app loads content directly from there via Astro'sglobloader, targeting top-level guides,docs/architecture/, anddocs/es/. Maintainer-only paths (agents/,template/,adr/) are excluded from public routes and search by default. The old duplicate content tree insideapps/docs/src/content/docs/is removed.A remark plugin (
markdown-links.ts) rewrites relative.md/.mdxlinks in source documents to their generated Starlight routes so cross-document links work correctly in both the rendered site and raw GitHub browsing.New and updated pages
docs/index.mdxanddocs/es/index.mdxas splash-template landing pages with hero sections, a scaffold command, and a card grid linking to major sections.title,description, sidebar order) to all existing guide documents.Site configuration and branding
SiteTitlecomponent renders aninit / docswordmark that links back to the marketing site, with the marketing URL resolved fromPUBLIC_MARKETING_URL, the dev default, or the production fallback.LastUpdatedcomponent derives the last-modified date fromgit logwhen the route metadata does not supply one.init-logo.svgfor use as a standalone wordmark asset andsocial-preview.svgfor Open Graph and Twitter card metadata.globals.cssusing a neutral monochrome palette, Geist Mono as the monospace font, and polished styles for the header, sidebar, code blocks, cards, asides, hero grid background, and pagination.astro.config.tswires up the site URL fromPUBLIC_SITE_URL, setsoutput: "static", configures edit links pointing to the GitHub source, adds Open Graph and theme-color head tags, and adds a Vite alias to resolve Starlight components correctly.404.astropage replaces Starlight's default with copy and navigation actions consistent with the site's voice.Marketing site (
apps/web)Headercomponent with a "Read the docs" link pointing todocs.init.now.DOCS_URLto the web app's constants and aweb_landing_header_docsi18n key in both English and Spanish catalogs.docs_example_greetingi18n key from both catalogs.