docs: sync documentation site with current code#76
Merged
Conversation
Docs were last updated 2026-01-23; src had a refactor batch on 2026-06-30. Bring the published site and root markdown back in line with the code. - Remove ADRs from the published site: drop the ADRs nav block and add exclude_docs for architecture/adr*.md. ADR files stay in the repo as engineering artifacts. Strip now-dangling ADR links from the staying architecture pages, replacing them with plain-text pointers. - Fix hybrid-search description: it is 5 signals (incl. title), not 4. Correct how-it-works, development, bm25-keywords, wordnet-enrichment. (api-reference and the per-type weight tables were already correct.) - REFERENCES.md: exceptions moved from domain/exceptions.ts to the modular domain/exceptions/ package (ConceptRAGError hierarchy). - USAGE.md: database path env var is DATABASE_URL, not CONCEPT_RAG_DB. - Resolve nav orphans: add skills-interface.md to the Architecture nav; exclude development.md (README-linked GitHub doc whose repo-relative links do not resolve on the rendered site). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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
Documentation was last updated 2026-01-23, but
src/had a refactor batch on 2026-06-30. This brings the published site (https://m2ux.github.io/concept-rag/) and the root markdown back in line with the code.Changes
ADRs removed from the published site (kept in-repo as engineering artifacts)
mkdocs.ymland addedexclude_docsforarchitecture/adr*.md.architecture/README,bm25-keywords,seeding-architecture,wordnet-enrichment,database-schema,stage-cache-structure), replacing them with plain-text pointers to the in-repo ADRs.Factual drift fixed
title), not 4 — correctedhow-it-works,development,bm25-keywords,wordnet-enrichment. (api-referenceand the per-type weight tables were already correct and were left untouched.)REFERENCES.md: exceptions moved from the monolithicdomain/exceptions.tsto the modulardomain/exceptions/package (ConceptRAGErrorhierarchy).USAGE.md: database-path env var isDATABASE_URL, not the non-existentCONCEPT_RAG_DB.Nav orphans resolved
skills-interface.mdto the Architecture nav.development.md(it's the README-linked GitHub doc; its repo-relative links don't resolve on the rendered site).Verification
adr*,development.md) remain in any published page; no residual "four-signal" text; all nav targets exist;exclude_docsglob + YAML structure validated.mkdocs buildcould not be run (this host's Python is externally-managed / PEP 668). CImkdocs gh-deploy(non-strict) will build on merge.Known issue (out of scope)
Two
adr0049files exist (-content-metadata-extractionand-incremental-category-summaries) — a number collision. Both are now excluded from the site; not renumbered here to avoid breaking inter-ADR links.🤖 Generated with Claude Code