Repository navigation
Documentation site at /docs, and URLs for the Folderite rename - #3
Merged
Merged
Conversation
MkDocs Material, set up like ZOrbit's: pages in docs/, theme overrides in docs-theme/ and docs/stylesheets/extra.css, published with the landing page by pages.yml. Pull requests that touch the docs run a strict build. Differs from ZOrbit in following the system's light or dark mode, like the landing page, and in site_dir: MkDocs' default output is site/, which it empties first, and that is the landing page's source here. Screenshots move to docs/images/. The manual test checklist moves from the README to docs/building.md. CLAUDE.md keeps the docs in step with the code.
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.
Adds a documentation site at
/docsand finishes the repo rename tocombwizard/Folderite.Docs
docs/, with theme overrides indocs-theme/anddocs/stylesheets/extra.css.pages.ymlpublishes the docs with the landing page. Pull requests that touch the docs run a strict build.site_diris set inmkdocs.ymlbecause MkDocs' default output issite/, which it empties first, and that folder is the landing page's source here.docs/images/, and the manual test checklist moves from the README todocs/building.md.CLAUDE.mdadds the rule for keeping the docs in step with the code.Rename
The repo is already renamed on GitHub. This updates the links, badges and
site_urlto the new name and the new Pages address,https://combwizard.github.io/Folderite/.combwizard.github.io/folderite/, stays a 404. There is no redirect.Testing
mkdocs build --strictpasses locally. I last ran it before the final commit, which changes no docs files.main, so it doesn't include this branch./Folderite/docs/, which first deploy when this merges.