docs: refresh documentation — rename files, fix API responses, add missing content - #152
Merged
Conversation
…ssing content
- Drop numbered prefixes from all doc files (00.installation.md → installation.md, etc.)
and update all 53 references across README.md, QuickStart.md, doc cross-links,
and docker/docker-compose.yaml
- Fix /api/v1/health response: returns {"status": "OK"} not {"status": "ok", "uptime": ...}
- Fix auth refresh response: correct envelope is {status, data: {token, user}, error}
- Fix auth logout response: correct body is {status, data: {logged_out: true}, error}
- Fix logs endpoint: use cursor-based pagination (limit/after) not page-based,
and correct response structure to {data: {items, items_count, limit, cursor}}
- Remove [PENDING] from entity list query params — document actual limit/after/sort support
- Add WebSocket realtime endpoint (WS /api/v1/realtime/ws) documentation
- Add application settings schema documentation (appName, baseUrl, maxFileSize, etc.)
- Remove duplicate "Entity Types and Validation" section from api.md
- Fix file storage path: <dataDir>/files/<entity>/<filename> not <dataDir>/<entity>/<filename>
- Add filename sanitization, path traversal protection, and limitation notes to files.md
- Add all MB_* environment variables to docker.md (MB_OAUTH_ENCRYPTION_KEY,
MB_REALTIME_SSE, MB_REALTIME_WS, MB_LOG_LEVEL, MB_DATABASE_TYPE, etc.)
- Trim QuickStart.md from 400 lines to ~170 — remove sections duplicated in README
- Fix typos in scripting.md (ay→any, reqires→requires, invokation→invocation)
- Fix "mantisapp" → "mantisbase" in scripting.md
- Fix "Mantis" → "MantisBase" in installation.md
- Remove emoji from section headers for consistency with README style
- Remove redundant H1 titles from docker.md and scripting.md (rely on @page tag)
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.
Summary
Comprehensive documentation refresh addressing all issues tracked in idea_board#25.
Changes
Renames (10 files)
00.installation.md→installation.md01.cmd.md→cmd.md02.api.md→api.md02.auth.md→auth.md03.rules.md→rules.md05.embedding.md→embedding.md06.docker.md→docker.md11.files.md→files.md12.healthcheck.md→healthcheck.md13.scripting.md→scripting.mdAPI Response Fixes
New Documentation
Test Plan