Skip to content

feat: publish the documentation and the card wizard from one Astro site - #489

Merged
martin-mfg merged 22 commits into
stats-organization:masterfrom
marcalexiei:docs-frontend-astro
Aug 23, 2026
Merged

feat: publish the documentation and the card wizard from one Astro site#489
martin-mfg merged 22 commits into
stats-organization:masterfrom
marcalexiei:docs-frontend-astro

Conversation

@marcalexiei

@marcalexiei marcalexiei commented Aug 16, 2026

Copy link
Copy Markdown

  • Turns apps/frontend into an Astro + Starlight site.
    Serves the docs at /frontend/docs and the card wizard at /frontend:
    one dev server, one build, one deploy, and no Python in vercel-preparation.sh or in the local setup.
  • The wizard becomes a page of that site: a React island on Starlight's splash layout,
    so it inherits the header, footer and search.
    Its own app bar, theme picker and Redux theme slice go away.
    Starlight writes the data-theme daisyUI already reads, so one control themes both halves.
  • The *.md sources move to apps/frontend/src/content/docs/docs/ with a title in
    frontmatter and Starlight's :::note asides, which lets Astro resolve their links and
    images natively (no markdown-conversion code of our own).
    starlight-links-validator then fails the build on a dead internal link.
  • packages/core/src/themes/README.md is generated into the site instead; README and CONTRIBUTING links follow the move.
  • Tailwind now shares a page with Starlight, so index.css declares the cascade-layer order
    (its utilities must outrank Starlight's reset) and scopes the app's element rules under
    .wizard, leaving the site identical on both halves.

To try it out just run

pnpm --filter ./apps/frontend run dev

Wizard Documentation
Screenshot 2026-08-17 at 00 54 18 Screenshot 2026-08-17 at 00 54 25

@vercel

vercel Bot commented Aug 16, 2026

Copy link
Copy Markdown

@marcalexiei is attempting to deploy a commit to the martin-mfg's projects Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
github-stats-extended-backend Ready Ready Preview Aug 23, 2026 12:06pm

Request Review

@marcalexiei

Copy link
Copy Markdown
Author

I made few changes with the last commit (totally fine if you want to go ahead without them):

  • Splits the "Advanced Customization" page into smaller pages, grouped in the sidebar under two categories:
    • Cards: one page per card
    • Customization: Common Options, Theming, Available Themes, Locales and Aligning Cards
    image
  • Moved the options shared by every card out from under "GitHub Stats Card", where they were nested despite applying to all of them.
  • Redirects /frontend/docs/advanced_documentation/ to "Common Options" and both group paths to their first page, so published URLs do not hit 404.
  • Links each card title in the Overview page's "Card Types" section to that card's page.

@marcalexiei
marcalexiei requested a review from martin-mfg August 19, 2026 02:21

@martin-mfg martin-mfg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I haven't completely reviewed all changes yet. But I reviewed most of them and don't want to keep you waiting longer for initial feedback.

Btw, good idea to go with Astro+Starlight instead of MkDocs. 👍

Comment thread apps/frontend/src/wizard/docsUrl.ts
Comment thread apps/frontend/package.json Outdated
Comment thread apps/frontend/astro.config.ts Outdated
Comment thread scripts/generate-theme-readme.js
Comment thread .github/CONTRIBUTING.md
Comment thread apps/frontend/index.html
Comment thread apps/frontend/src/content/docs/docs/advanced_documentation.md Outdated
Comment thread apps/frontend/src/content/docs/docs/advanced_documentation.md Outdated
Comment thread apps/frontend/src/content/docs/docs/customization/aligning-cards.md
Comment thread apps/frontend/src/content/docs/docs/customization/theming.md Outdated
Comment thread apps/frontend/astro.config.ts Outdated
Comment thread apps/backend/vercel.json
* url in markdown snippet
* links to GitHub's GraphQL API docs had to be updated
* remove domain from 2 links to the card wizard
* remove domain from 1 link to another doc page
@martin-mfg
martin-mfg merged commit e0de81e into stats-organization:master Aug 23, 2026
7 of 8 checks passed
@marcalexiei
marcalexiei deleted the docs-frontend-astro branch August 23, 2026 15:50
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.

Publish documentation from release instead of master

2 participants