Skip to content

docs: fix 17 documentation inconsistencies#33

Merged
Intina47 merged 2 commits intoIntina47:mainfrom
didierhk:docs/consistency-audit-fixes
Apr 11, 2026
Merged

docs: fix 17 documentation inconsistencies#33
Intina47 merged 2 commits intoIntina47:mainfrom
didierhk:docs/consistency-audit-fixes

Conversation

@didierhk
Copy link
Copy Markdown
Contributor

Summary

Ran a full documentation consistency audit against code and cross-referenced all 12 docs for contradictions. Found and fixed 17 issues:

  • 5 CONFLICT — factual errors (wrong platform count, misleading Notion capabilities, nonexistent CHANGELOG.md reference, wrong config paths)
  • 3 STALE — outdated info (test script says v1.0.3, Node 16+ requirement, stale dates)
  • 3 INCOMPLETE — missing info (undocumented database tables, nonexistent scripts/ dir reference, wrong tool count in comment)
  • 3 DRIFT — misleading descriptions (Notion write code described as user-facing, wrong CLI path, missing file-watch capability)
  • 1 MISSING — broken reference (CHANGELOG.md)
  • 2 GAP — undocumented module + filename typo

Key fixes

File What changed
docs/NOTION_INTEGRATION.md Corrected capabilities to match MCP tool (search/read only, not read-write). Fixed Node.js requirement (18+, not 16+). Fixed filename typo (was INTERGRATION).
ARCHITECTURE.md Fixed platform count (11, not 14). Removed Codewisperer/Ollama, added Antigravity. Fixed Claude Desktop config path. Added 9 missing database tables. Added project-metrics.ts to Layer 3. Fixed CLI path. Expanded auto-config section to list all 11 platforms. Removed nonexistent CHANGELOG.md reference.
package.json Fixed test script version (v2.0.0). Replaced missing CHANGELOG.md with docs/**/* in files array.
AGENTS.md Removed nonexistent scripts/ directory reference.
src/core-tools.ts Fixed comment (8 tools, not 9).
docs/audits/ Added full audit report with methodology and evidence.

Overlap with #28

This PR touches some of the same files as #28. The changes are complementary — #28 expands documentation, this PR fixes factual accuracy. Recommend merging #28 first; this PR should rebase cleanly with minor conflicts.

Test plan

  • Verify all doc claims match code (core-tools.ts tool count, schema.ts tables, platform-configs.cjs platforms)
  • Confirm docs/NOTION_INTEGRATION.md renamed correctly (no broken links)
  • Check npm test prints correct version string
  • Verify package.json files array is valid for npm publish

- Fix Notion docs claiming write capabilities when MCP tool only exposes search/read
- Correct platform count from 14 to 11; add Antigravity, remove Codewisperer/Ollama
- Fix Claude Desktop auto-config path, expand to list all 11 platforms
- Remove nonexistent CHANGELOG.md and scripts/ references
- Update stale version string in test script (v1.0.3 -> v2.0.0)
- Fix Node.js requirement from 16+ to 18+
- Add missing database tables and project-metrics.ts to architecture docs
- Fix core-tools.ts comment (9 -> 8 tools)
- Rename NOTION_INTERGRATION.md -> NOTION_INTEGRATION.md (typo)
- Add audit report to docs/audits/
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ca88052571

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@Intina47 Intina47 merged commit 235fd51 into Intina47:main Apr 11, 2026
1 check passed
@Intina47
Copy link
Copy Markdown
Owner

@didierhk Thank you, and congratulations on your first merged PR on Context Sync! 🎉 We truly appreciate your contribution and are excited to see more amazing PRs from you in the future. Keep up the great work!

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.

2 participants