Skip to content

docs(proposals): use glob toctree to prevent merge conflicts#1115

Open
smoparth wants to merge 1 commit intomainfrom
fix/glob-proposals-index
Open

docs(proposals): use glob toctree to prevent merge conflicts#1115
smoparth wants to merge 1 commit intomainfrom
fix/glob-proposals-index

Conversation

@smoparth
Copy link
Copy Markdown
Contributor

@smoparth smoparth commented May 5, 2026

Replace the hand-maintained file list in docs/proposals/index.rst with Sphinx's :glob: directive. This eliminates recurring merge conflicts when multiple proposal PRs are open simultaneously, as new proposals no longer need to modify the index file.

Closes: #1108

Replace the hand-maintained file list in docs/proposals/index.rst with
Sphinx's :glob: directive. This eliminates recurring merge conflicts
when multiple proposal PRs are open simultaneously, as new proposals
no longer need to modify the index file.

Closes: #1108
Signed-off-by: Shanmukh Pawan <smoparth@redhat.com>
@smoparth smoparth requested a review from a team as a code owner May 5, 2026 16:20
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d811248d-b1a3-4dba-a978-17bf5ac3916a

📥 Commits

Reviewing files that changed from the base of the PR and between 1429c1a and 1f127f9.

📒 Files selected for processing (1)
  • docs/proposals/index.rst

📝 Walkthrough

Walkthrough

The proposal index documentation file transitions from a manually maintained list of four proposal entries to an automated glob-based pattern. The Sphinx toctree directive now uses :glob: with a wildcard (*) to automatically discover and include all proposal documents in the directory, eliminating the need for manual updates when new proposals are added.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed Title clearly describes the main change: using glob toctree in proposals index to prevent merge conflicts.
Description check ✅ Passed Description explains the purpose (eliminating merge conflicts), the solution (using :glob: directive), and references the closed issue #1108.
Linked Issues check ✅ Passed Code changes fully implement issue #1108 requirements: :glob: directive replaces explicit file list, enabling automatic discovery of proposal files without index modifications.
Out of Scope Changes check ✅ Passed All changes in docs/proposals/index.rst are directly related to implementing the glob toctree pattern specified in issue #1108, with no extraneous modifications.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

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.

Automate the manually maintained proposals index file to avoid merge conflicts

1 participant