Repository navigation
docs: publish a documentation site and an English readme - #44
Merged
Merged
Conversation
The documentation is a Material for MkDocs site, built by `mkdocs build --strict` in CI and published to https://metasekailab.github.io/nnnotes/ from main. Its navigation follows the kind of page: - Tutorial: a quick start from an empty config file to an exported story. - How-to guides: configuration, exporting stories and lives, building an ournotes-player site, the asset export, the Japanese release and the music data. - Reference: the generated command reference, the command outputs, the JSON schemas of nnnotes.schemas, the contracts, stages, views, replay data and UI library. - Explanation: the architecture and its layers, what makes the outputs deterministic, and the validation experiments over a whole game version with their reproduction steps. README.md is now the English readme and the package page, with README.zh-CN.md as its translation. The changelog header states which interfaces the version numbers cover. The command reference no longer repeats a default its help already states. pip install 'nnnotes[docs]' installs the site's tools. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
mkdocs.yml,docs/), built withmkdocs build --strictin CI and published to GitHub Pages from main by.github/workflows/docs.yml.README.mdis now the English readme and the package page;README.zh-CN.mdis its translation.pip install 'nnnotes[docs]'installs the site's tools.Tests
tests/test_repo.pychecks:nnnotes.schemas.names().mkdocs build --strictpasses, with anchor checks.Co-Authored-By: Claude Opus 5.5 noreply@anthropic.com