Repository navigation
docs: audit and rewrite the engine user docs - #470
Merged
Merged
Conversation
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 does this PR do?
No linked issue: this is a full audit of the engine user docs, requested directly. Every page was checked against the current packages and modules, then fixed or rewritten for game developers.
nf new. New pages: a quickstart 2D game, and core concepts (factory,app.use/init/run, libraries, context, loop hooks, ECS, client/server split, writing a library).docs/design/. The docs repo PR adds redirects for them.registry/*is relabelled "ECS internals". No other slug changed.How do you test this PR?
network-client/network-serverpackages, and the ECS page claimed class renaming by bundlers was harmless.tsc --noEmitagainst the built packages. The game itself was not run in a browser.mint validate,mint broken-linksandmint a11yon a scratch copy of the site with all four source branches (engine, cli, loader, editor) and the docs redirects synced in: all pass, 83 pages.pnpm exec prettier --checkand the pre-push hook (lint, tests): pass.Merge danger
Door: two-way, docs only: a revert is enough.
Blast radius: the public docs.nanoforge.eu, at this repo's next release (docs-sync), not at merge.
Follow-up issues
To be filed: the client-only
nf newsample fails without a.env(cli);LibraryRelationshipsTSDoc contradictsrunBefore/runAfter; stale README and TSDoc examples (asset, ecs, sound, music, core, editor-lib, networkICE_SERVERS).Quality gate
reviewer: findings fixed in the last commitmint a11y)style-reviewer: pass