Skip to content

docs: add architecture overview docs#1250

Open
LalatenduMohanty wants to merge 1 commit into
python-wheel-build:mainfrom
LalatenduMohanty:docs/bootstrapper-architecture
Open

docs: add architecture overview docs#1250
LalatenduMohanty wants to merge 1 commit into
python-wheel-build:mainfrom
LalatenduMohanty:docs/bootstrapper-architecture

Conversation

@LalatenduMohanty

@LalatenduMohanty LalatenduMohanty commented Jul 11, 2026

Copy link
Copy Markdown
Member

Add architecture overview docs

Also add an AGENTS.md rule to keep the docs in sync when the architecture changes.

Closes: #1247

@LalatenduMohanty LalatenduMohanty requested a review from a team as a code owner July 11, 2026 03:02
@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@LalatenduMohanty, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 49 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5d9a2c32-d7aa-46a8-b499-2fb5955f13c6

📥 Commits

Reviewing files that changed from the base of the PR and between 9766874 and 5c2a741.

📒 Files selected for processing (7)
  • AGENTS.md
  • docs/concepts/architecture-overview.rst
  • docs/concepts/bootstrapper-architecture.rst
  • docs/concepts/hooks-and-overrides.rst
  • docs/concepts/index.rst
  • docs/concepts/package-settings.rst
  • docs/concepts/resolver-architecture.rst
📝 Walkthrough

Walkthrough

Adds architecture documentation for Fromager’s subsystems, bootstrapper phase pipeline, resolver/provider behavior, layered package settings, and hooks or overrides. The concepts index now links the new pages, while AGENTS.md requires architecture documentation to remain synchronized with related code changes.

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

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning Besides the bootstrapper doc, the PR adds resolver, hooks, package-settings, and overview docs that are not part of #1247's scope. Split the extra concept pages into a follow-up PR or link the relevant issues; keep this change focused on the bootstrapper architecture doc and AGENTS rule.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and matches the main change: adding architecture docs.
Description check ✅ Passed The description matches the docs-focused changes and mentions the AGENTS sync rule.
Linked Issues check ✅ Passed The bootstrapper architecture doc covers the requested phase flow, Phase contract, WorkItem behavior, and thread-pool model from #1247.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/concepts/bootstrapper-architecture.rst`:
- Around line 1-6: Add a Sphinx `.. versionadded::` directive near the beginning
of the Bootstrapper Architecture document, using the release version that
introduced this new user-facing documentation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8cfd8523-ddb0-4830-af89-cd2473a0ddc7

📥 Commits

Reviewing files that changed from the base of the PR and between fdf55b3 and 129b2c1.

📒 Files selected for processing (3)
  • AGENTS.md
  • docs/concepts/bootstrapper-architecture.rst
  • docs/concepts/index.rst

Comment thread docs/concepts/bootstrapper-architecture.rst
@LalatenduMohanty LalatenduMohanty force-pushed the docs/bootstrapper-architecture branch from 129b2c1 to 8fed1d7 Compare July 11, 2026 03:06
@LalatenduMohanty LalatenduMohanty marked this pull request as draft July 11, 2026 03:07
@LalatenduMohanty LalatenduMohanty force-pushed the docs/bootstrapper-architecture branch from 8fed1d7 to 47622cc Compare July 11, 2026 15:18
@LalatenduMohanty LalatenduMohanty marked this pull request as ready for review July 11, 2026 15:20
@LalatenduMohanty LalatenduMohanty force-pushed the docs/bootstrapper-architecture branch from 47622cc to f2a037c Compare July 11, 2026 15:21

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/concepts/index.rst`:
- Line 16: Update the Package Settings entry in the documentation to render the
PackageBuildInfo class name with reStructuredText inline code markup using
double backticks, while leaving the surrounding description unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 255e70a9-158c-4ad8-9a07-9a73317de426

📥 Commits

Reviewing files that changed from the base of the PR and between 129b2c1 and 47622cc.

📒 Files selected for processing (7)
  • AGENTS.md
  • docs/concepts/architecture-overview.rst
  • docs/concepts/bootstrapper-architecture.rst
  • docs/concepts/hooks-and-overrides.rst
  • docs/concepts/index.rst
  • docs/concepts/package-settings.rst
  • docs/concepts/resolver-architecture.rst
✅ Files skipped from review due to trivial changes (5)
  • docs/concepts/bootstrapper-architecture.rst
  • docs/concepts/architecture-overview.rst
  • AGENTS.md
  • docs/concepts/package-settings.rst
  • docs/concepts/resolver-architecture.rst

Comment thread docs/concepts/index.rst Outdated
@LalatenduMohanty LalatenduMohanty changed the title docs: add bootstrapper architecture overview docs: add architecture overview docs Jul 13, 2026
@LalatenduMohanty LalatenduMohanty force-pushed the docs/bootstrapper-architecture branch from f2a037c to 9766874 Compare July 13, 2026 12:39
Also add an AGENTS.md rule to keep the docs in sync
when the architecture changes.

Closes: python-wheel-build#1247
Co-Authored-By: Claude <claude@anthropic.com>
Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
@LalatenduMohanty LalatenduMohanty force-pushed the docs/bootstrapper-architecture branch from 9766874 to 5c2a741 Compare July 13, 2026 12:48
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.

docs: add architecture overview for bootstrapper subpackage

1 participant