Skip to content

fix(docs): index the research document #17231 landed, unbreaking main - #17253

Closed
mrveiss wants to merge 1 commit into
mainfrom
hotfix-research-index-17231
Closed

mrveiss wants to merge 1 commit into
mainfrom
hotfix-research-index-17231

Conversation

@mrveiss

@mrveiss mrveiss commented Sep 22, 2026 •

Copy link
Copy Markdown
Owner

Thinking Path

main is red. test_every_research_document_is_reachable_from_its_index reports
present but unindexed: ['on-prem-private-ai-platform-stack'].

#17231 added docs/research/on-prem-private-ai-platform-stack.md and never added its row to
docs/research/_index.md. That is precisely the drift the test exists to catch — its own
docstring cites the index having drifted five documents — and I missed it when landing that PR.

This is base breakage: every open PR picks the red up on its next run, so it is deliberately
one line and separate from any other work, to merge ahead of the queue.

What Changed

One row appended to docs/research/_index.md, in the table's existing append order (the file is
chronological, not alphabetical — checked before inserting), describing the document and naming
its umbrella and child issues the way neighbouring rows do.

Verification

  • grep confirms the slug is absent on origin/main and present once after the change.
  • The row matches the | [[slug]] | description | shape of the surrounding entries, and sits
    before ## Related Sections like every other row.
  • The document itself is unchanged.

Not verified locally: the test is not executed here — CI is the authority — but the assertion is
a set difference between files on disk and slugs in this index, and the missing slug is now
present.

Model Used

Claude Opus 5 (1M context)

Refs #17231

Summary by CodeRabbit

  • Documentation
    • Added a research entry comparing on-premises private-AI platforms.
    • Documented gaps in the reachability of declared controls.
    • Linked the research to the relevant tracking issues.

main is red on
doc_sync_hook_resolves_indexer_15845_test::test_every_research_document_is_reachable_from_its_index
with 'present but unindexed'. #17231 added docs/research/on-prem-private-ai-platform-stack.md
and never added its _index.md row, which is exactly the drift that test was
written for -- and I missed it when landing that PR.

This is base breakage, not one PR's problem: every open PR inherits the red on
its next run. Kept to the single line so it can merge ahead of the queue.
@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: mrveiss/AutoBot-AI/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: cf0f09bc-e4dc-493c-93ea-9852339ebb02

📥 Commits

Reviewing files that changed from the base of the PR and between 43d3762 and 04a5a3a.

📒 Files selected for processing (1)
  • docs/research/_index.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The Documents index now includes the on-premises private-AI platform comparison. The entry records production reachability findings and links the related umbrella and child issues.

Changes

Research documentation

Layer / File(s) Summary
Add research document entry
docs/research/_index.md
The Documents index now lists on-prem-private-ai-platform-stack with its reachability findings and associated issues.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 04a5a

The documentation index change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: it indexes the research document in the documentation index to restore the main branch.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mrveiss

mrveiss commented Sep 22, 2026

Copy link
Copy Markdown
Owner Author

Folded into #17241 (fa38144388) rather than run as its own CI. A two-line docs fix does not justify a full suite, and queue depth was delaying the fix that matters. Content is identical.

@mrveiss mrveiss closed this Sep 22, 2026
@mrveiss
mrveiss deleted the hotfix-research-index-17231 branch September 23, 2026 18:27
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.

1 participant