Docs: Better Tabbed examples

[Kilo59]

Summary by Sourcery

Improve and expand documentation for using ruff-sync, particularly around layered configuration and path-specific syncing, while updating referenced versions and tooling.

Enhancements:

• Update referenced ruff-sync and ruff-pre-commit hook versions to newer releases in configuration examples.

Documentation:

• Document layered upstream configuration in usage docs with CLI and pyproject examples.
• Refine --path usage documentation with tabbed examples for subdirectories, nested paths, and specific config files, and link to a real-world example.
• Clarify README examples for FastAPI presets and update the Agent Skill path link formatting.
• Highlight the bundled Agent Skill as a key feature on the documentation landing page.

[github-actions]

Wily: No changes in complexity detected.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.52%. Comparing base (c43075a) to head (b7fe897).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #126   +/-   ##
=======================================
  Coverage   90.52%   90.52%           
=======================================
  Files           4        4           
  Lines         728      728           
=======================================
  Hits          659      659           
  Misses         69       69           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sourcery-ai]

Reviewer's Guide

Updates and expands ruff-sync documentation with layered configuration and tabbed --path examples, refreshes usage examples and links, and bumps pre-commit Ruff versions to stay current.

Flow diagram for choosing a --path usage example

flowchart TD
  Start([Need_to_sync_config_from_upstream_repo])
  PathNeeded{Is_the_config_in_a_non_default_location_or_specific_file?}

  Start --> PathNeeded

  PathNeeded -- No --> DefaultSearch["Use ruff_sync without --path and rely on default search"]
  PathNeeded -- Yes --> LocationType{What_do_you_want_to_target?}

  LocationType -- Subdirectory_at_single_depth --> Subdirectory["Use --path backend"]
  LocationType -- Deeply_nested_directory --> NestedPath["Use --path configs/standards/python/backend"]
  LocationType -- Specific_pyproject_toml_file --> PyprojectFile["Use --path backend/pyproject.toml"]
  LocationType -- Specific_ruff_toml_or_dot_ruff_toml_file --> RuffFile["Use --path tools/ruff.toml"]

  DefaultSearch --> End([ruff_sync_uses_default_config_search])
  Subdirectory --> End
  NestedPath --> End
  PyprojectFile --> End
  RuffFile --> End

Loading

File-Level Changes

Change	Details	Files
Document support for layered upstream configurations using multiple URLs in CLI and pyproject.toml.	Add a new "Layer-Based Configuration" section explaining how multiple upstreams are merged sequentially. Provide CLI example showing multiple upstream repositories passed to ruff-sync. Provide equivalent pyproject.toml configuration snippet using an upstream array.	docs/usage.md
Improve --path usage docs with tabbed examples for different path targets and link to a real-world example.	Replace single --path example with tabbed sections for subdirectory, nested path, specific pyproject.toml, and specific ruff.toml targets. Clarify that --path can target either subdirectories or specific config files. Add a cross-link to the Pre-defined Configs page demonstrating --path usage.	docs/usage.md
Refresh README examples and Agent Skill references to match current repo structure and recommended usage.	Update pre-commit hook rev in README to v0.1.2 in the example configuration. Change Agent Skill path mention into a clickable markdown link to the local .agents/skills/ruff-sync-usage/ directory. Adjust a FastAPI configuration example to showcase using --path against this repository as the source.	README.md
Keep tooling pinned to the latest Ruff pre-commit hook release.	Bump astral-sh/ruff-pre-commit hook version from v0.15.6 to v0.15.7.	.pre-commit-config.yaml
Highlight bundled Agent Skill as a first-class feature on the docs landing page.	Add a new bullet to the features list on the docs index describing the bundled Agent Skill capability.	docs/index.md
Update dependency lockfile to reflect the new configuration and tool versions.	Regenerate or modify uv.lock to capture dependency or version changes introduced in this PR.	uv.lock

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}