feat: docs site (Docusaurus) with quick start, features, troubleshooting, FAQ - #116
Merged
Merged
Conversation
…ing, FAQ Scaffolds docs-site/ (Docusaurus, published to GitHub Pages by .github/workflows/docs.yml on main), content for the standard doc set a self-hosted OSS project needs, and updates CLAUDE.md's Definition of Done to require docs stay current with user-facing changes going forward.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Adds docs-site to hestia_dep_update.sh's NPM_MODULES loop alongside frontend, and adds a type-check/audit:ci script pair + audit-ci.json so the loop's existing npm run audit:ci step (not --if-present) doesn't fail. Forces serialize-javascript to ^7.1.1 via overrides to clear a high-severity ReDoS advisory (GHSA-5c6j-r48x-rmvq) pinned transitively by Docusaurus's own bundler, rather than allowlisting it.
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
2 participants
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
docs-site/(Docusaurus, TypeScript), published to GitHub Pages by.github/workflows/docs.yml(already merged tomaindirectly, per the CI-file convention inCLAUDE.md).CLAUDE.md's Definition of Done + Conventions to requiredocs-site/docs/stay current with user-facing changes in the same PR going forward, not as a follow-up.Spec:
docs/current_spec.md.Follow-ups (not blocking this PR)
main— the workflow is dormant until then.Test plan
npm run buildindocs-site/— clean, no broken links (onBrokenLinks: 'throw')npm run typecheckindocs-site/— cleandocs-site/)