Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ pnpm e2e:last-failure # error-context.md of the last failed test, its last fra
- `example-plugin`: `@acme/hello`, the dev plugin loaded by the e2e tests.
- **`examples/breakout`**: a client-only game made of scenes (`@nanoforge-dev/scene`, engine `modules/scene`), the default of `pnpm example` (`scripts/example.mjs`): it links the engine libraries from `NANOFORGE_ENGINE` (default `../engine`, shared with the e2e setup through `engineRoot`) and starts the built editor on port 4800 with `FS_ROOT=examples`. Its entities and systems all belong to scenes (`GameScene`), so the Scene screen and Hierarchy show none: use Play and the World panel.
- **`examples/counter-plugin`**: a standalone plugin, outside the workspace, as `nf create plugin` writes it (the CLI command is in `../cli`).
- **`docs/docs`**: the user documentation and the plugin authoring guide (Mintlify pages, copied to the docs site).
- **`docs/docs`**: the user documentation and the plugin authoring guide (Mintlify pages). The release copies it to the `editor` folder of the docs site (`.github/nanoforge.json` → `docs`). `docs/docs/navigation.json` sets the sidebar order: every page must be listed in it, once. Link pages relative to the file (`../editor/play`); the sync makes them absolute.
Screenshots are in `docs/docs/images`, taken on the engine's pong-network example (`create-project.png` and `init-project.png` show the projects website, kept from the previous documentation). The plugin guide walks through `examples/counter-plugin`.

### Manifests: packages and plugins (ADR 0003)

Expand Down
50 changes: 0 additions & 50 deletions docs/docs/README.md

This file was deleted.

43 changes: 43 additions & 0 deletions docs/docs/navigation.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[
{
"group": "Getting started",
"icon": "rocket",
"pages": ["getting-started/introduction", "getting-started/create-your-first-project"]
},
{
"group": "Using the editor",
"icon": "pen-ruler",
"pages": [
"editor/overview",
"editor/adapt-a-project",
"editor/layout",
"editor/files",
"editor/code-editor",
"editor/entities",
"editor/components",
"editor/systems",
"editor/scenes",
"editor/play",
"editor/settings",
"editor/git",
"editor/plugins-and-packages"
]
},
{
"group": "Plugins",
"icon": "puzzle-piece",
"pages": [
"plugins/overview",
"plugins/create-your-first-plugin",
"plugins/manifest",
"plugins/sdk",
"plugins/extension-points",
"plugins/widgets-and-styles",
"plugins/themes",
"plugins/settings",
"plugins/history",
"plugins/code-and-codegen",
"plugins/engine-libs"
]
}
]
Loading