Skip to content

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

Merged
mergify[bot] merged 1 commit intomainfrom
fix/glob-proposals-index
May 6, 2026
Merged

docs(proposals): use glob toctree to prevent merge conflicts#1115
mergify[bot] merged 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

@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: 7b7177e6-2ee2-4897-acaf-05074967ba23

📥 Commits

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

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

📝 Walkthrough

Walkthrough

Replaced the explicit list of proposal pages in docs/proposals/index.rst with a Sphinx toctree using the :glob: directive and * wildcard, so all proposal documents in the directory are discovered and included automatically instead of being listed manually.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: using glob toctree in the proposals index to prevent merge conflicts.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of replacing the hand-maintained file list with Sphinx's :glob: directive.
Linked Issues check ✅ Passed The PR implements all acceptance criteria from #1108: uses :glob: directive, maintains existing proposals visibility, and enables adding new proposals without modifying index.rst.
Out of Scope Changes check ✅ Passed The change is narrowly scoped to docs/proposals/index.rst and directly addresses the stated objective of replacing the manual file list with a glob pattern.

✏️ 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.

@tiran
Copy link
Copy Markdown
Collaborator

tiran commented May 6, 2026

@Mergifyio rebase

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>
@tiran tiran force-pushed the fix/glob-proposals-index branch from 1f127f9 to fc41f59 Compare May 6, 2026 11:28
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 6, 2026

rebase

✅ Branch has been successfully rebased

@mergify mergify Bot merged commit 63e9021 into main May 6, 2026
43 checks passed
@tiran tiran deleted the fix/glob-proposals-index branch May 6, 2026 12:03
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

2 participants