Repository navigation
Add a Backend section for mistwarp-api - #18
Merged
Merged
Conversation
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/.
This was referenced Nov 1, 2026
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
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.
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:
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.