Repository navigation
docs: documentation site built with Angular SSR, deployed to GitHub Pages - #297
Merged
Merged
Conversation
Add a prerendered Angular application under packages/docs that turns the content of the READMEs and packages/cli/docs into a structured site with a landing page, sidebar navigation, per-page table of contents, callouts and highlighted code blocks. Pages are Markdown files imported as text and rendered with marked and highlight.js; every route is prerendered to static HTML with /user-flow/ as base href. The docs workflow builds the site and deploys it to GitHub Pages on pushes to main that touch the docs.
…pages-docs-7e165c # Conflicts: # .prettierignore # package-lock.json # package.json
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Use the push-based design system for tokens only. The header, hero and favicon now use the user-flow UFO mark, and the PushBased logo is gone. Semantic colour roles with light and dark values sit on top of the raw token ramps; the site follows the system scheme and a header toggle stores an explicit choice.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Tables stack into labelled rows below phone-landscape width, the measurement mode table fits desktop widths with inline icons, the table of contents follows the section in view, cards and the hero adapt to small screens, and a pass over the prose fixes hyphenation and wording.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
The logo is inlined as SVG so the wordmark and mark recolour for dark mode.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
The 160px PNG blurred at hero size and on high-density screens. The mark is now an inline SVG component whose outline and body colours follow the theme, with an SVG favicon and PNG icons rendered from it.
This reverts commit 3b96fb6.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
❗❗❗ report generated by this PR ❗❗❗☕ Order Coffee ☕Date/Time: 2026-10-24 20:34
|
☕ Order Coffee ☕Date/Time: 2026-10-24 20:34
|
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.
Summary
Adds a proper documentation site for
@push-based/user-flowunderpackages/docs, deployed to GitHub Pages at https://push-based.github.io/user-flow/.@angular/ssr(outputMode: static) so every route ships as static HTML with/user-flow/as base href.packages/cli/docs/*.mdand the Nx plugin README rewritten into 15 pages across five sections: getting started, CLI reference, writing user flows, integrations and resources. Facts were checked against the CLI source (option names, defaults, CLI modes, replay step types, the Nx target generator output).loaderoption and rendered withmarked+highlight.js. Fenced blocks supporttitle="...",> [!TIP]style callouts render as boxes, in-app links are rewritten for the base href and routed client side..github/workflows/docs.ymlbuilds and deploys on pushes tomainthat touch the docs. Unknown routes fall back to the app shell through404.html.Setup after merge
The repository's Settings → Pages → Source must be set to GitHub Actions once, otherwise the deploy job cannot publish.
Local usage
Test plan
nx build docsprerenders 18 routes, no warnings/user-flow/and checked in a browser: landing page, docs pages, sidebar, table of contents, callouts, tables, code highlighting, mobile menunx run-many -t build --projects=cli,nx-pluginstill passesIssues
Closes #223.
Related, not fully covered by this PR: #214 (configuration examples per level and budgets) and #228 (link
serveCommandfrom the GitHub action docs).