Skip to content

docs: refresh docs formatting, links, and diagrams#2624

Merged
crivetimihai merged 4 commits intomainfrom
doc-fix-all
Feb 1, 2026
Merged

docs: refresh docs formatting, links, and diagrams#2624
crivetimihai merged 4 commits intomainfrom
doc-fix-all

Conversation

@crivetimihai
Copy link
Copy Markdown
Member

@crivetimihai crivetimihai commented Feb 1, 2026

Summary

  • Normalize MkDocs list formatting to prevent collapsed bullets and improve readability.
  • Fix internal doc links/anchors flagged by mkdocs serve (broken relative paths, missing anchors).
  • Align API documentation with actual runtime ports and auth requirements (8000 dev, 4444 serve, 8080 docker‑compose via nginx; health/readiness/base URLs).
  • Update Mermaid diagrams to match current code paths (OAuth UI flow, multitenancy/SSO/admin flows) and ensure diagrams render in both themes.
  • Link generated architecture diagrams produced by make docs.

Related

Coverage vs #2483

Addressed

  • DOC‑04: API reference accuracy (ports/auth/health/base URL alignment).
  • DOC‑05 (partial): Architecture diagrams current (updated Mermaid content + linked generated diagrams).
  • DOC‑08 (partial): Broken links (internal links/anchors fixed from MkDocs warnings).

Not addressed

  • DOC‑01: OpenAPI lint/endpoint diff.
  • DOC‑02: Run/validate all curl examples end‑to‑end.
  • DOC‑03: Full quickstart walkthrough validation.
  • DOC‑06: CHANGELOG review.
  • DOC‑07: README validation against current behavior.
  • External link checker + schema response validation.

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
@crivetimihai crivetimihai self-assigned this Feb 1, 2026
@crivetimihai crivetimihai added this to the Release 1.0.0-RC1 milestone Feb 1, 2026
@crivetimihai crivetimihai added the documentation Improvements or additions to documentation label Feb 1, 2026
Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
@crivetimihai crivetimihai merged commit bb32897 into main Feb 1, 2026
48 checks passed
@crivetimihai crivetimihai deleted the doc-fix-all branch February 1, 2026 15:34
hughhennelly pushed a commit to hughhennelly/mcp-context-forge that referenced this pull request Feb 8, 2026
* docs: refresh documentation formatting and links

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* docs: remove unused snakefood diagram

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* docs: align api auth and readiness examples

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* Docs update - diagram review

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

---------

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
Signed-off-by: hughhennnelly <hughhennelly06@gmail.com>
kcostell06 pushed a commit to kcostell06/mcp-context-forge that referenced this pull request Feb 24, 2026
* docs: refresh documentation formatting and links

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* docs: remove unused snakefood diagram

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* docs: align api auth and readiness examples

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

* Docs update - diagram review

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

---------

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant