Repository navigation
docs: add a documentation site published to GitHub Pages - #14
Merged
Merged
Conversation
Port the user-flow docs site to this package: an Angular app prerendered to static HTML, with guides, an API reference, the upstreaming plan, search and a landing page made for soft navigations.
The upstreaming plan now lives on the docs site, so the Markdown copy in docs/ goes.
Move the docs site to pnpm and bring its user-flow, throttling and API pages up to date with main.
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.
Closes #13
Adds a documentation site built and published the same way as the user-flow docs.
What's in it
packages/docs: the user-flow Angular docs app (prerendered static HTML, search, light/dark theme, edit links, "last updated" dates), rebranded with a new lighthouse mark.docs/upstreaming-to-lighthouse.md)scripts/og-image.mjs..github/workflows/docs.yml: builds on pushes tomainthat touch the docs, then deploys to https://push-based.github.io/lighthouse-soft-navigation/.Workspace changes
highlight.js,markedand@nx/webadded as dev dependencies.docsis excluded from the@nx/js/typescriptplugin, because itstsc --buildtypecheck emits declarations, which doesn't work for an Angular app. Instead,docshas its owntypechecktarget that runstsc --noEmit..angularis ignored.Before merging
Set the repository's Pages source to GitHub Actions (Settings → Pages), or the deploy job will fail.
The npm links point to
@push-based/lighthouse-soft-navigation, which isn't published yet.Checks
nx format:checkandnx run-many -t lint test build typecheckpass locally. The production build prerenders all 17 routes. I checked the landing page, the doc pages, the diagrams and the 404 page in light and dark themes and at phone width.