Skip to content

Index documents as well #490

Closed as not planned
Closed as not planned

Description

@hrstoyanov

What problem does this solve?

I have codebase along with docs in htmlx, asciidoc, mdx - can we index the docs as well an correlate with the code graph?

Proposed solution

No idea

Alternatives considered

No response

Confirmations

  • I searched existing issues and this is not a duplicate.

Activity

  1. DeusData commented on Jun 18, 2026

    @DeusData
    Owner

    Great idea, thank you @hrstoyanov 🙏 This is adjacent to a couple of open threads: #504 (import existing ADR docs) and #346 (a memory.md). The graph today is code structure first, so correlating prose docs with code is a larger feature.

    The realistic first step is lighter than full doc indexing: extract headings and the code symbols a doc references (fenced code identifiers, inline code spans, explicit links) and create "documents" edges to existing graph nodes, rather than semantically embedding the prose. Which formats matter most to you, in priority order (Markdown and MDX, AsciiDoc, HTML)? That'll help us scope a first cut!

  2. hrstoyanov commented on Jun 18, 2026

    @hrstoyanov
    Author

    I have a web scraper tool that downloads documentation (html) and converts it to markdown.

    You may want to take a look at QMD - it does very well with the docs, not so much with figuring out code and graphs

    Ideally I want one tool that does it all

  3. hrstoyanov commented on Jun 18, 2026

    @hrstoyanov
    Author

    Btw I love the "single fast executable" approach. Too much models and python slop out there

  4. added
    priority/normalStandard review queue; useful PR with ordinary maintainer urgency.
    on Jun 30, 2026
  5. added this to the 0.9.2-rc milestone on Jul 8, 2026
  6. added
    parsing/qualityGraph extraction bugs, false positives, missing edges
    on Sep 5, 2026
  7. DeusData commented on Oct 2, 2026

    @DeusData
    Owner

    Thanks for clarifying that you convert scraped HTML documentation to Markdown, and for your patience while this waited in triage. That gives useful context for the format question above.

    We’re keeping Issues focused on actionable defects. Please open a Discussion with this request and a link back here, so documentation indexing and links between headings, referenced symbols, and the code graph can be explored together.

    I’m closing this issue as an administrative redirect to that discussion venue. Feature acceptance, prioritization, and implementation timing remain undecided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestparsing/qualityGraph extraction bugs, false positives, missing edgespriority/normalStandard review queue; useful PR with ordinary maintainer urgency.

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions