Repository navigation
docs: the documentation site at ferropix.eu, the book and the landing page - #50
Merged
Merged
Conversation
… page The landing page at the site root in the FerroHEALTH design with the Plum and Iron accent, and the mdBook under /docs/: what FerroPIX is with every capability marked built or planned, getting started, the published crates with every feature, configuration, deployment, security and audit, operations, the specification pins rendered from docs/VERSIONS.md, contributing and the changelog. scripts/site/assemble.sh builds the site as Pages serves it, with the version markers rendered from the manifests, the favicon staged from assets/brand and a hashed CSP on every page. The Docs workflow builds it on every pull request and deploys it from main, and the site-links job of CI lints the book and checks every internal link offline inside the required conclusion check.
…phone layout FerroEHR and FerroFED are planned to resolve patients through the FerroPIX server (FerroHEALTH/FerroEHR#3380, FerroHEALTH/FerroFED#367); the book and the README now say so and link both, and the README marks the server's description as planned. The landing page's roadmap names each open milestone with its theme and link, never its issue counts, which went stale between deploys. On a phone the install commands fit their box, and a longer line scrolls inside it, never the page.
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
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.
What changed and why
FerroPIX gets the documentation site every other FerroHEALTH product has, served at https://ferropix.eu/.
website/book/, under/docs/): introduction; what FerroPIX is, with a status table marking each capability built (inihe-itiornl-generic-functions) or planned (the v0.0.3 server, linked to its milestone); getting started with the doctested PIXm example; the published crates with every feature and the docs.rs links; configuration, deployment, security and audit, and operations, each saying plainly that the server is planned and what holds today; conformance with the specification and toolchain tables included fromdocs/VERSIONS.md; licensing; contributing; keeping the book current; and the changelog included fromCHANGELOG.md. Shared topics link the FerroHEALTH family book. BSNk is named as not built: no code calls the BSNk service.lightandnavyrecoloured with the "Plum & Iron" palette, the mark beside the title, system fonts, and a hashed per-page CSP (scripts/site/book-csp.sh), as the family book does.website/landing/): the FerroFED and FerroBRIDGE structure and stylesheet with the plum accent, light and dark, a'self'-only CSP, and the roadmap rendered from the open milestones.favicon.svg,favicon-32.png,favicon-16.png,favicon.icoandferropix-icon-dark.svg. The book takes the favicon from a staged copy at assembly, so the artwork exists once and needs no sync guard.versions.shexempts PNG and ICO from the licence-header check, as it does JSON.scripts/site/assemble.sh(landing at/, book at/docs/, version markers such as{{version:ihe-iti}}rendered from the manifests so no page types a version, favicon staged, CSP per page, roadmap),scripts/site/toolchain.shreading the new "Documentation toolchain" rows ofdocs/VERSIONS.md(mdBook 0.5.4, mdbook-lint 0.14.4, lychee 0.24.2, the family book's pins), and.github/actions/docs-toolchain..github/workflows/docs.yml): build on every pull request and push, deploy to thegithub-pagesenvironment frommain, pinned digests,permissions: {}, no CNAME file (the custom domain is the Pages setting, as on ferrofed.eu).site-linksjob (scripts/checks/site-links.sh, with--self-test) runs mdbook-lint, assembles the site and checks every internal link and anchor offline, plus README, inside the requiredconclusion.CLAUDE.md's repo map nameswebsite/,scripts/site/andassets/brand/.The rule, the same-PR book guard, the docs-claims and writing-style guards follow in the next pull request (#48).
Closes #45
Closes #46
Closes #47
Closes #49
Licensing of contributions
Checklist
shellcheck --severity=style,actionlint,zizmor --min-severity=low .github/, and the self-test of every script the change touches.CHANGELOG.mdhas an[Unreleased]entry.