docs: fix cross-doc inconsistencies (tool count, env vars, anchors, EN/ES parity)#116
Merged
Conversation
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
Fixes documentation inconsistencies found in a cross-doc audit (README, docs/**, .github, examples). Verified against the real code before each change. Docs-only — no production code changes (one MCP server module docstring updated). Both EN and ES doc copies kept in sync.
Tool count → 14
Multiple docs claimed 11/12/13 MCP tools; the server actually exposes 14. Corrected in:
engrama/adapters/mcp/server.pymodule docstring ("eleven" → "fourteen", addedengrama_status,engrama_reindex,engrama_gdpr_forget)docs/architecture.md/.es.md("Thirteen" → "Fourteen", added the missingengrama_gdpr_forgetentry)docs/backends.md/.es.md,docs/vision.md/.es.md,docs/roadmap.md/.es.md,examples/claude_desktop/system-prompt.mdStale "not yet on PyPI" caveats
vision,backendsandindex.essaid Engrama wasn't on PyPI and to install from source — contradicting the README (PyPI badge +pip install engramaquick start). Updated topip install engrama. Left DDR-004's design-time note as a historical record.Env vars documented but unused in code
HYBRID_ALPHA/HYBRID_GRAPH_BETA— never read; superseded by theENGRAMA_FUSION_MODE/ENGRAMA_RRF_K/ENGRAMA_GRAPH_*family. Replaced in.env.exampleand thearchitectureconfig tables with the real knobs.ENGRAMA_PROFILE— never read; the schema profile is the--profileCLI flag. Removed from.env.exampleand thearchitecture/indexconfig tables.NEO4J_USER→NEO4J_USERNAME(code usesNEO4J_USERNAME) in DDR-003 EN/ES example blocks.EMBEDDING_PROVIDER=null→none(canonical value).EN/ES parity
docs/index.md(EN) was missing the Codex and ChatGPT Desktop MCP-integration subsections thatindex.es.mdalready had. Ported them and restructured the heading to## MCP integrationwith### Claude Desktop/### Codex/### ChatGPT Desktop.Broken anchors
index.md: internal link updated for the renamed heading (#mcp-integration-claude-desktop→#mcp-integration).backends.es.md:#capa-de-protocolo-y-backends→#capa-de-protocolos-y-backends(heading is plural).index.es.md: two accented anchors (#configuración-...,#referencia-de-configuración) → ASCII-folded forms that mkdocs actually generates.Minor
.github/ISSUE_TEMPLATE/bug.yml: repro placeholder used a non-existentengrama rememberCLI command andengrama initwithout the required--profile; replaced with valid commands.Notes / left as-is (intentional)
HYBRID_*and "not yet on PyPI" are point-in-time decision records — left intact (except theNEO4J_USERtypo).docs/changelog.md"10 tools" entry is a historical release note — left intact.docs/glosario.mdis an acknowledged EN translation stub — out of scope.Test plan
grepsweep confirms no residualHYBRID_ALPHA/HYBRID_GRAPH_BETA/ENGRAMA_PROFILE/NEO4J_USER=in current-facing docs