docs: add Docusaurus documentation site in docs-website - #894
Merged
Conversation
Adds a documentation website which brings the existing guides together and closes the biggest gap: the admin panel had no usage documentation at all. Content: * Getting Started - requirements/ports, docker, from source, connecting a game client, test accounts * Deployment - the three variants, HTTPS, and the start parameters and environment variables of the startup project * Admin Panel - one page per screen (setup, configuration updates, servers, accounts, online accounts, game configuration, plugins, chat commands, map editor, live map, logs and monitoring, users) plus a page with task-oriented how-tos * Development - architecture, solution structure, the plugin system and contributing * Reference - ports and a pointer to the generated packet documentation Setup: * Docusaurus 3 in docs-website, docs-only mode, offline search (@easyops-cn/docusaurus-search-local), light/dark theme * The build fails on broken links, anchors and image references * A GitHub Actions workflow builds the site for pull requests which touch it * The deployment URL is configurable via DOCS_URL/DOCS_BASE_URL, so a Cloudflare Pages project or a fork doesn't need a code change * README.md and QuickStart.md link to the site The favicon is a placeholder, and screenshots for the admin panel pages are still to be added. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LidmXPYjGN64P1RgCiY7Ri
The site duplicated what it was built from, so each topic now has exactly one home: * The website owns what a user, operator or new contributor reads: getting started, deployment, the admin panel, server features, architecture, the plugin system and contributing. * The repository keeps the documentation which is derived from or tightly bound to the code: the generated packet descriptions, the game mechanics in docs/ and the implementation notes in the projects' Readme files. Moved to the website: * docs/Bots.md becomes the new "Server features" section, cross-linked with the plugins, servers, logs and game configuration pages of the admin panel * src/Web/AdminPanel/Readme.md and src/Web/Map/Readme.md - the latter was an outdated copy of the former; their "ideas for the future" are now the planned sections of the admin panel overview and the live map page Replaced by a short pointer to the page which now holds the content: QuickStart.md, the four deploy readmes, src/Startup/Readme.md, src/PlugIns/Readme.md, docs/Bots.md, src/Web/AdminPanel/Readme.md and src/Web/Map/Readme.md. README.md keeps the project introduction and gains a documentation index; its duplicated sections (used technologies, gameplay differences, deployment, contribution rules) now live on the website and in CONTRIBUTING.md. docs/Readme.md becomes the index of the code-bound documentation and explains the split. All relative links were verified to resolve, and the site build - which fails on broken links - passes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LidmXPYjGN64P1RgCiY7Ri
Deploying openmudocs with
|
| Latest commit: |
49192a4
|
| Status: | ⚡️ Build in progress... |
The plugin implementation is a developer topic, so it doesn't belong on the documentation website, which is aimed at users and server operators. src/PlugIns/Readme.md is restored to its previous state (byte-identical to master) and is the single source again; the website's development/plugins.md is removed and the places which linked to it now link to the readme: * the Development section of the sidebar and the architecture page * the PlugIns row of the solution structure * "Writing your own plugin" on the admin panel's Plugins page, which keeps covering what operators do with plugins: activate, deactivate, configure * CONTRIBUTING.md and the docs index Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LidmXPYjGN64P1RgCiY7Ri
Resolves the conflict in docs/Bots.md, whose content moved to the documentation website in this branch while master reworked the bot party behaviour: the file keeps its pointer and the changes from master were applied to the page which now holds the content. Also follows the network analyzer split from master, which turned the analyzer into a library plus a WinForms tool, in the solution structure page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LidmXPYjGN64P1RgCiY7Ri
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
2 participants
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.
Closes #889.
Adds a documentation website which brings the existing guides together and closes the biggest gap: the admin panel had no usage documentation at all.
The site lives in
docs-website/and is built with Docusaurus 3 in docs-only mode.Admin panel section — the new content
One page per screen, written from the actual routes and components rather than from the old feature list in
src/Web/AdminPanel/Readme.md:-reinit, schema updatesAccountStatevalues, banning, disconnecting, the offline-player tableSystemConfigurationfields, how the generic grid/form pages and the configuration search work.htpasswdbased users, the default credentials, the Traefik restart caveatMigrated content
The Getting Started, Deployment, Development and Reference sections consolidate
README.md,QuickStart.md, the fourdeploy/**readmes,src/Startup/Readme.md,src/PlugIns/Readme.mdanddocs/Readme.md, with the links fixed for the site.README.mdandQuickStart.mdare kept as they are and only gained a pointer to the site — they can be trimmed once the site has a public URL.Setup
@easyops-cn/docusaurus-search-local, no external service or account needed), light/dark theme, hand-maintained sidebar..github/workflows/docs-website.ymlbuilds the site for pull requests which touchdocs-website/**, so a dead link fails before the merge.DOCS_URLandDOCS_BASE_URLenvironment variables, so a Cloudflare Pages project or a fork does not need a code change.docs-website/README.mdcontains the Cloudflare Pages settings (root directorydocs-website, build commandnpm ci && npm run build, outputbuild, Node 20+).Deliberately left open
reference/packets.mdlinks to them on GitHub. This was one of the open decisions in Docs: Usage documentation site with Docusaurus (incl. the missing admin panel documentation) #889 and is worth deciding before wiring them in.https://docs.munique.netis the configured default and easy to change.Testing
🤖 Generated with Claude Code
https://claude.ai/code/session_01LidmXPYjGN64P1RgCiY7Ri
Generated by Claude Code