Index repo docs/ as a TechDocs-style markdown corpus #48

Closed
opened 2026-05-23 20:55:27 +00:00 by coilysiren · 1 comment
Owner

Originally filed by @coilysiren on 2026-05-12T07:50:55Z - https://github.com/coilysiren/repo-recall/issues/88

Index markdown files under each indexed repo's docs/ directory (and a configurable set of fallback paths: README.md, CONTRIBUTING.md, ARCHITECTURE.md) into repo-recall's recall layer. Surface answers with file+line citations.

Why

  • Repo-recall is already in the recall business. Joining session history to in-repo docs is a natural extension and a credible reason to show up next to Backstage's TechDocs without rebuilding their MkDocs pipeline.
  • "Docs live as markdown next to code" is the convention TechDocs popularized. Adopt the convention, skip the build pipeline.
  • Citations are cheap when the corpus is plain markdown on disk.

Scope

  • Walk docs/**/*.md plus top-level README/CONTRIBUTING/ARCHITECTURE.
  • Index into the existing recall store. Same query surface as session recall.
  • Dashboard: results carry repo + file path + line range.

Out of scope

  • MkDocs / Sphinx / mdBook build pipelines.
  • Rendering markdown in the dashboard beyond what we already do for session output.
  • Cross-repo doc linking (revisit after catalog-info lands, #87).

Cross-ref: discussion comparing repo-recall to Backstage, decided to cherry-pick features rather than ship a Backstage plugin.

_Originally filed by @coilysiren on 2026-05-12T07:50:55Z - [https://github.com/coilysiren/repo-recall/issues/88](https://github.com/coilysiren/repo-recall/issues/88)_ Index markdown files under each indexed repo's `docs/` directory (and a configurable set of fallback paths: `README.md`, `CONTRIBUTING.md`, `ARCHITECTURE.md`) into repo-recall's recall layer. Surface answers with file+line citations. ## Why - Repo-recall is already in the recall business. Joining session history to in-repo docs is a natural extension and a credible reason to show up next to Backstage's TechDocs without rebuilding their MkDocs pipeline. - "Docs live as markdown next to code" is the convention TechDocs popularized. Adopt the convention, skip the build pipeline. - Citations are cheap when the corpus is plain markdown on disk. ## Scope - Walk `docs/**/*.md` plus top-level README/CONTRIBUTING/ARCHITECTURE. - Index into the existing recall store. Same query surface as session recall. - Dashboard: results carry repo + file path + line range. ## Out of scope - MkDocs / Sphinx / mdBook build pipelines. - Rendering markdown in the dashboard beyond what we already do for session output. - Cross-repo doc linking (revisit after catalog-info lands, #87). Cross-ref: discussion comparing repo-recall to Backstage, decided to cherry-pick features rather than ship a Backstage plugin.
Author
Owner

Iceboxed in the 2026-05-29 backlog burn-down: TechDocs-style corpus indexing, speculative feature expansion. Reopen anytime if it becomes real.

Iceboxed in the 2026-05-29 backlog burn-down: TechDocs-style corpus indexing, speculative feature expansion. Reopen anytime if it becomes real.
Sign in to join this conversation.
No labels
P0
P1
P2
P3
P4
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
coilyco-flight-deck/repo-recall#48
No description provided.