Skip to content

docs: comprehensive documentation review and fixes#2642

Merged
crivetimihai merged 6 commits intomainfrom
g-docs-review
Feb 2, 2026
Merged

docs: comprehensive documentation review and fixes#2642
crivetimihai merged 6 commits intomainfrom
g-docs-review

Conversation

@crivetimihai
Copy link
Copy Markdown
Member

Summary

  • Comprehensive review of all 218 documentation files in docs/docs/
  • Fixed typos, placeholder content, and formatting issues
  • Updated document statuses and removed stale content
  • Added explanatory notes where needed

Changes

Typo Fixes

  • architecture/oauth-design.md:65 - Fixed "e00 seconds" → "300 seconds"
  • using/plugins/index.md:134 - Fixed "extenal" → "external"
  • development/developer-workstation.md:171 - Fixed "your-exail@example.com" → "your-email@example.com"

Content Updates

  • using/servers/ibm/instana.md - Added TBD markers to 12 empty placeholder sections for clarity
  • architecture/adr/012-dropdown-ui-tool-selection.md - Changed empty "PR created: " to "Implemented."
  • test/sbom.md - Added explanatory note about auto-generated content with placeholder values
  • overview/quick_start.md - Status updated to published
  • architecture/oauth-design.md - Streamlined content and fixed formatting
  • testing/acceptance.md - Updated test report template

Housekeeping

  • .gitignore - Unignored documentation files (FEATURES.md)
  • Removed empty blog/index.md placeholder
  • Fixed navigation in various .pages files

Review Tracking

Full review details available in todo/claude-review.md

Test plan

  • Verify documentation builds without errors (make docs or mkdocs build)
  • Spot-check fixed typos render correctly
  • Verify links in modified files work

Closes #2499

@crivetimihai crivetimihai merged commit a476139 into main Feb 2, 2026
38 checks passed
@crivetimihai crivetimihai deleted the g-docs-review branch February 2, 2026 00:02
hughhennelly pushed a commit to hughhennelly/mcp-context-forge that referenced this pull request Feb 8, 2026
* chore: unignore documentation files in .gitignore

* chore: unignore FEATURES.md documentation files

* docs: update oauth design and remove empty blog index

* docs: cleanup placeholders, update statuses, and fix navigation

* typo

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

* Documentation review & update

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
* chore: unignore documentation files in .gitignore

* chore: unignore FEATURES.md documentation files

* docs: update oauth design and remove empty blog index

* docs: cleanup placeholders, update statuses, and fix navigation

* typo

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

* Documentation review & update

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TESTING] Documentation Site Test Plan

1 participant