docs: add automated branded Docusaurus site - #807
Open
bballdavis wants to merge 11 commits into
Open
bballdavis wants to merge 11 commits into
bballdavis wants to merge 11 commits into
Conversation
bballdavis
marked this pull request as ready for review
September 8, 2026 18:51
bballdavis
marked this pull request as draft
September 8, 2026 18:52
dialmaster
requested changes
Sep 8, 2026
bballdavis
marked this pull request as ready for review
September 9, 2026 14:12
dialmaster
requested changes
Sep 13, 2026
dialmaster
requested changes
Sep 16, 2026
dialmaster
left a comment
Collaborator
There was a problem hiding this comment.
One more thing before I approve: website/package-lock.json is basically missing the resolved and integrity fields. Only 11 of the 1311 entries have them (the root lockfile has them on all 830). Those hashes are how npm ci confirms the tarball it downloads is the exact one the lock was generated from, so without them the version pins don't actually protect us from anything. I'm guessing the lock got built from a node_modules that was installed some other way first.
Can you delete website/node_modules and the lockfile, run npm install in website/, and commit the regenerated lock?
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 I changed
I added a Docusaurus documentation site that builds from the Markdown files we already maintain. I kept the existing docs as the source of truth and made the site output deterministic.
I also:
docs/Markdown filesdocs:check,docs:build, and related npm scriptscheck-allwait for itmainCLAUDE.md, and the Docker migrations heading linkWhy I made this
I want the documentation we already write to stay in one place while the public site stays current. When the source Markdown or API routes change, the checks and site build will catch broken links and regenerate the site.
Validation
I ran the original documentation checks and verified the PR workflow:
npm run docs:checknpm run docs:buildDocumentation Sitepassed on the current PR headThe generated output stays ignored under
website/.generated/andwebsite/build/.The aggregate
All Checksjob is currently blocked by the repository Security Audit job reporting existing runtime dependency advisories. Those dependency changes are outside this documentation update.After this reaches
main, GitHub Pages will publish the site at https://dialmasterorg.github.io/Youtarr/.This is a draft so I can review the scope and the generated output before making it ready.