Skip to content

docs: match the editor docs to the current ui, sdk and manifest - #234

Merged
Exeloo merged 5 commits into
mainfrom
docs/rewrite-content
Nov 7, 2026
Merged

Exeloo merged 5 commits into
mainfrom
docs/rewrite-content

Conversation

@Exeloo

@Exeloo Exeloo commented Nov 7, 2026

Copy link
Copy Markdown
Member

What does this PR do?

No linked issue: this is a full audit of docs/docs, requested directly. Every page was checked against the current UI labels, menus, shortcuts, settings, manifest and SDK, and fixed where it no longer matched.

  • Getting started: introduction and create-your-first-project are rewritten as a path for a first-time reader. The EDITOR_TOKEN warning is kept and made clearer.

  • Editor pages: labels and behaviour fixed on 13 pages, and the alt text of every screenshot rewritten. Examples: six docks, "Save layout as…", Settings › Editor › Appearance, the Game toolbar, Git amend and rollback.

  • Plugin guide: wrong facts fixed:

    • the server contract uses streams;
    • a changed file clears its whole history;
    • the ECS plugin has four extension points;
    • the tour example's button is "Add";
    • the item owner's infer/claims hooks;
    • the viewport/scenes features.

    Missing fields and options are added.

  • navigation.json is unchanged: no page is added, removed or renamed.

How do you test this PR?

  • Before / after: about 60 claims were checked against the code by an independent reviewer. The four it found wrong are fixed in the last commit.
  • docs-sync check, then mint validate, mint broken-links and mint a11y on 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 --check and the pre-push hook (lint, tests): pass.
  • Prettier ignores .mdx in this repo, so it does not check these pages.

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: onScreen:code-editor.script activation event never fires; Prettier does not check docs/docs .mdx; the static formatter only reads JSON/YAML Prettier configs.

Quality gate

Lane Result
Docs the change is docs
Correctness independent reviewer: findings fixed in the last commit
Accessibility (content) pass (alt text, headings, link text; mint a11y)
Security (content) pass, no secrets or internal URLs
Style style-reviewer: pass
Performance N/A (docs)

@Exeloo
Exeloo requested a review from Tchips46 as a code owner November 7, 2026 01:55
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 7, 2026
@Exeloo
Exeloo merged commit 944ae5e into main Nov 7, 2026
9 checks passed
@Exeloo
Exeloo deleted the docs/rewrite-content branch November 7, 2026 01:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant