docs: document the multi-site architecture and how to work on all sites#41
Merged
Conversation
Expand the README from a minimal 'Sub-sites' bullet list into a full architecture overview: a Mermaid diagram of the four-repo + custom-domain setup, a site table (repo / URL / default branch / build entrypoint), per-site local-dev and deploy instructions, and the shared conventions (per-page OG, shared og:image, sitemap+robots, directory-style URLs, cross-site link target) that keep the ecosystem consistent. Also fixes the deploy badge to point at the actual workflow (build.yml, not the non-existent deploy-pages.yml).
🔗 Link Check FailedResultsSummary
Errors per inputErrors in .vitepress/dist/README/index.html
|
…im checks it) lychee runs with include_verbatim=true, so the http://localhost:5173 URL in the code comment was extracted and checked — and failed (connection refused in CI). The comment now just describes the command; npm run dev prints the URL anyway.
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.
Expands the README from a 2-line "Sub-sites" bullet list into a full architecture guide for the whole fontist.org family of sites.
What's in it
fontist.orgcustom domain (served at/); each subsite is a separate repo whose own GitHub Pages is served atfontist.org/<repo>/.main, orv5for formulas), and build entrypoint for each site.cd docs/,npm run dev).build.yml/docs.yml; nothing manual. Includes a per-repo workflow table noting formulas' batched build (4,300+ pages).transformHead, sharedog:imagePNG,sitemap.xml+robots.txtper site, directory-style URLs (post-build dirify), and cross-site links usingtarget="_self"to avoid the SPA-router client-side 404.BlogPostingJSON-LD.Also fixed
deploy-pages.yml, which doesn't exist. Corrected tobuild.yml(the actual workflow).Verification
README.mdonly — no code/build changes. Mermaid diagram uses standard flowchart syntax that renders on GitHub.