Docs update and Contributing Guidelines

[Kilo59]

Summary by Sourcery

Update project documentation and add contributor guidelines and curated configuration docs.

Documentation:

• Link README to hosted documentation, installation, configuration, CI, troubleshooting, and API reference pages.
• Add documentation pages for pre-defined Ruff configurations and contributor guidance, including navigation entries in MkDocs.

Chores:

• Add a top-level CONTRIBUTING guide describing development workflow, testing standards, and how to contribute curated configs.

[sourcery-ai]

Reviewer's Guide

Adds contributor documentation and curated configuration docs, wires them into the MkDocs navigation, and updates the README to link prominently to the hosted documentation and new guides.

Flow diagram for navigating updated documentation links

flowchart TD
  A[GitHub README] --> B[Docs badge link]
  A --> C[Documentation link in Table of Contents]

  B --> D[Docs home page]
  C --> D

  D --> E[Installation Guide]
  D --> F[Configuration Guide]
  D --> G[Pre-defined Configs]
  D --> H[Pre-commit Guide]
  D --> I[CI Integration Guide]
  D --> J[Troubleshooting]
  D --> K[API Reference]
  D --> L[Contributing page]

  E --> A1[Install ruff-sync]
  F --> A2[Configure ruff-sync in pyproject.toml]
  G --> A3[Choose curated Ruff configuration]
  H --> A4[Integrate with pre-commit]
  I --> A5[Add check command to CI pipeline]
  J --> A6[Resolve common issues]
  K --> A7[Use programmatic API]
  L --> A8[Follow contribution workflow]

Loading

Flow diagram for contributing a curated Ruff configuration

flowchart TD
  A[Read Pre-defined Configs doc] --> B[Decide to contribute new config]
  B --> C[Read Contributing docs]
  C --> D[Join discussion on Issue 83]
  D --> E[Agree on scope and domain]

  E --> F[Create configs/my-domain directory]
  F --> G[Add ruff.toml with inline comments]
  G --> H[Optionally add README explaining goals]

  H --> I[Run quality checks and tests]
  I --> J[Commit and push branch]
  J --> K[Open PR referencing Issue 83]
  K --> L[Address review feedback]
  L --> M[Config merged and available as curated option]

Loading

File-Level Changes

Change	Details	Files
Expose hosted documentation and deep-link to key guides from the README.	Add MkDocs documentation badge to the header badges section. Add Documentation, Troubleshooting, and API Reference entries to the README table of contents pointing to the hosted docs site. Add inline links in the Install, Configuration, CI Integration, and Curated Examples sections to the corresponding hosted documentation pages.	README.md
Extend MkDocs navigation to include pre-defined configs and contributing pages.	Add a Pre-defined Configs entry under the Usage subsection of the MkDocs nav. Add a top-level Contributing page entry to the MkDocs nav.	mkdocs.yml
Introduce a comprehensive contributing guide for repository collaborators.	Create CONTRIBUTING.md with setup instructions, development workflow, code conventions, testing requirements, quality checks, and curated config contribution process. Define expectations for tooling (uv, invoke, ruff, mypy, pytest) and how to run them. Document lifecycle TOML fixture scaffolding and guidelines for bug reports and PR submission.	CONTRIBUTING.md
Document pre-defined Ruff configuration presets for users of ruff-sync.	Create docs/pre-defined-configs.md describing curated configurations (Kitchen Sink, FastAPI & Async, Data Science & Engineering) including their purpose, key features, and usage examples. Show how to set a curated configuration as the default upstream in pyproject.toml. Add contribution entry points for community-submitted curated configs referencing Issue Add example Ruff configurations for various domains #83 and the main CONTRIBUTING guide.	docs/pre-defined-configs.md
Provide a concise in-docs contributing overview that links back to the main contributing guide.	Create docs/contributing.md summarizing getting started, quality checks, testing practices, curated config contributions, bug reporting, and PR tips. Link to the GitHub-hosted CONTRIBUTING.md and existing testing standards document for full details. Reference the new Pre-defined Configs docs page for curated configuration examples.	docs/contributing.md

---

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.

[github-actions]

Wily: No changes in complexity detected.

[sourcery-ai]

Hey - I've found 1 issue

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/pre-defined-configs.md" line_range="46" />
<code_context>
+
+## 📊 Data Science & Engineering
+
+Optimized for data science workflows, focusing on readability and common patterns found in Jupyter notebooks, pandas, and numpy code.
+
+### Key Features
</code_context>
<issue_to_address>
**nitpick (typo):** Consider capitalizing "NumPy" as a proper name.

This also keeps capitalization consistent with nearby proper names like Jupyter and pandas, and matches common usage in the docs.

Suggested implementation:

```
Optimized for data science workflows, focusing on readability and common patterns found in Jupyter notebooks, pandas, and NumPy code.

```

If there are other occurrences of "numpy" used as a proper noun elsewhere in the docs, they should also be updated to "NumPy" for consistency.
</issue_to_address>

---

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.}

[codecov]

Codecov Report

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #120   +/-   ##
=======================================
  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.