Skip to content

fix: reject a research topic named index.md - #36

Merged
si618 merged 1 commit into
mainfrom
fix/research-index-topic
Oct 21, 2026
Merged

si618 merged 1 commit into
mainfrom
fix/research-index-topic

Conversation

@si618

@si618 si618 commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

What changed

A research topic named research/index.md is now a staging error, and
it's left out of the pages and the sidebar. A new test covers it.

Checked with just check.

Why

The research overview is staged at research/index.md, so a topic
with that name would land on the same page and be overwritten without
a word. CodeRabbit found this on awesome-humans/dotnet#195, after #35
merged here.

Refs: #35, awesome-humans/dotnet#195

@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: awesome-humans/coderabbit/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8b2e9c3c-5128-4c58-90ec-fbd1a8f94d15
📥 Commits

Reviewing files that changed from the base of the PR and between faa194e and 93b115d.

📒 Files selected for processing: 1
  • xtask/src/build_site.rs

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 4 remain after this review.

📝 Walkthrough

The research topic scan now rejects research/index.md, reports an error that asks the author to rename it, and skips further processing. A test verifies the error and confirms the file is not staged as a topic.

Changes: Research topic validation

Layer / File(s) Summary
Reject the reserved research index path
xtask/src/build_site.rs
research_topics reports an error for research/index.md and skips further processing. A test checks the error and confirms the file is not staged as a topic.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 93b11

No merge-blocking risk was identified in this narrowly scoped validation change.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: rejecting a research topic named index.md.
Description check Passed The description directly explains the staging error, exclusion from generated pages and the sidebar, the test coverage, and the reason for the change.
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: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@si618
si618 merged commit a745118 into main Oct 21, 2026
9 checks passed
@si618
si618 deleted the fix/research-index-topic branch October 21, 2026 08:20

This branch was successfully deployed

1 active deployment
preview — 93b115d2 Deployed Oct 21, 2026 by si618 via deploy / deploy #36
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