Skip to content

Maintain the documentation ​

The framework project website and documentation have their own repository. This keeps the marketing site out of the downloadable server framework. The community website/UCP/ACP remain in the framework’s web-platform/ directory.

Local workflow ​

From the website repository root:

sh
npm ci
npm run dev

VitePress serves documentation source with live reload. To build the combined static site:

sh
npm run build
npm run serve

The combined preview uses port 4173 by default, with documentation under /docs/. Stop the preview when done. PORT can choose another preview port. Docker/EasyPanel serves the built site through Nginx on port 80.

Edit a guide ​

Write Markdown under documentation/. Add its navigation entry in documentation/.vitepress/config.mts. Use clear headings, relative links and concrete prerequisites. Distinguish default behaviour from optional/configured features and do not describe placeholders as completed editors.

The site provides local full-text search, keyboard access, code copying, page outlines, previous/next links, light/dark themes and print styles. No hosted search key is needed. The Markdown source remains readable outside the web app.

Refresh generated references ​

When a framework checkout is beside the website, its source can be discovered automatically. Otherwise set FRAMEWORK_ROOT to its absolute directory, then run npm run reference or npm run build.

The script extracts active-looking CMD: declarations, source locations, nearby comments, syntax messages and staff constants while excluding commented-out code. It does not evaluate the Pawn preprocessor or prove complete access-control expressions. Availability and helper/alias checks still need review.

Generated Markdown and safe public example files are committed. An independent website checkout can build from those snapshots without access to the private framework repository. Set FRAMEWORK_ROOT when you want to refresh them rather than using the snapshots.

Validate and deploy ​

npm run build regenerates references when source is available, builds VitePress and checks generated pages, local assets and links/anchors. Inspect search, mobile navigation and representative pages in a browser after meaningful theme changes.

The separate website Dockerfile builds the docs and copies the marketing pages/assets plus generated /docs/ into Nginx. In EasyPanel, use repository-root build context, Dockerfile, and domain target port 80. A source push is not the same as verifying a successful deployment.

Keep private data out ​

Generate examples only from checked-in .env.example, config.example.json, mysql.example.ini and the secrets template. Never embed .env.local, configured secrets.pwn, preview credentials, mail keys, real logs or player dumps. Gallery images should use a disposable preview with demonstration data.

Open-source roleplay foundations for open.mp. Bring your own world.