Skip to content

Add a Backend section for mistwarp-api - #18

Merged
Mistium merged 1 commit into
masterfrom
backend-docs
Nov 1, 2026
Merged

Mistium merged 1 commit into
masterfrom
backend-docs

Conversation

@Mistium

@Mistium Mistium commented Nov 1, 2026

Copy link
Copy Markdown
Member

mistwarp-api's reference material lived in its README, which should be an overview of the project. This adds a Backend section to the docs, split by topic:

Page Covers
Backend Overview What the service does, running it locally, the `src//` layout, where it runs
Configuration How settings are read, and every environment variable
Accounts and Sign-in The Rotur sign-in flow, plans, bans
Safety and Moderation Safety signals, reports, error reports, project source access
Payments and Webhooks Rotur payment requests, the end of project sales, Rotur webhooks
Projects and Storage The upload pipeline, commit inspection, storage limits, the backpack
Community Features Badges, milestone notifications, the development feed

The text is the README's own, reorganised. Stale parts are corrected: the deployment notes said the community site came from a webpack entry and that the dev server proxied the API, and the development feed had an em dash.

Two contributing pages said the API stores data as flat JSON. Community data is in SQLite (`data/community.db`), with other state as JSON under `data/`, so those lines now say that and link to the new section.

The layout page describes the structure from MistWarp/api's `src-layout` branch, which opens alongside this.

Checks: `docusaurus build` succeeds with no broken links. There are no UI changes beyond the new sidebar section.

The API's reference material lived in its README: configuration, the sign-in flow, bans,
plans, safety signals, payments, webhooks, storage, the backpack, badges and more. It now
has its own section, split by topic, and the README goes back to being an overview.

Also corrects two pages that said the API stores data as flat JSON. Community data is in
SQLite, with other state as JSON files under data/.
@Mistium
Mistium merged commit 3122bfc into master Nov 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant