Description:
While the current documentation is thorough regarding the CLI and configuration files, there are opportunities to improve the "Time to Success" for new users and provide clarity for enterprise-grade deployments.
Proposed Additions:
- Visual Conceptual Model: A diagram illustrating the "Hub and Spoke" model (Standards Repo →
.ruff-sync.toml → Project Repos) to help users visualize the tool's role in the development lifecycle.
- Merge Priority Matrix: A clear table defining the conflict resolution logic. For example, explicitly documenting what happens when
max-line-length is defined in both the remote and local pyproject.toml (e.g., "Local overrides Remote").
- Private Repository Auth Guide: A dedicated page or section explaining how to handle authentication (using
GITHUB_TOKEN, ssh-agent, or .netrc) when syncing from private organizational repositories.
- The "Flow of Data" Guide: A walkthrough showing the life of a rule change—from the moment it's updated in the standards repo to how a developer sees it locally.
Value:
These additions will lower the barrier to entry for large teams and clarify the tool's behavior during complex configuration merges.
Description:
While the current documentation is thorough regarding the CLI and configuration files, there are opportunities to improve the "Time to Success" for new users and provide clarity for enterprise-grade deployments.
Proposed Additions:
.ruff-sync.toml→ Project Repos) to help users visualize the tool's role in the development lifecycle.max-line-lengthis defined in both the remote and localpyproject.toml(e.g., "Local overrides Remote").GITHUB_TOKEN,ssh-agent, or.netrc) when syncing from private organizational repositories.Value:
These additions will lower the barrier to entry for large teams and clarify the tool's behavior during complex configuration merges.