Skip to content

Add Organization Rules Documentation #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jun 1, 2025

This PR adds comprehensive documentation for the Organization Rules setting that allows users to specify global rules across all repositories in their organization.

What's Added

  • New documentation file: docs/settings/organization-rules.mdx
  • Updated navigation: Added the new page to docs.json in the Settings section
  • Comprehensive coverage: Includes rule hierarchy, examples, best practices, and troubleshooting

Key Features Documented

  • How Organization Rules work as global defaults
  • Rule hierarchy (Organization Rules → Repository Rules)
  • Setup instructions with clear steps
  • Practical examples for common use cases:
    • Git workflow standards
    • Code quality requirements
    • Security guidelines
    • Documentation standards
  • Best practices for writing effective rules
  • Troubleshooting guide for common issues
  • Links to related settings

Context

This addresses the gap identified where the Organization Rules feature (shown in the settings UI) didn't have corresponding documentation. The feature allows setting organization-wide rules that apply to all repositories unless overridden by repository-specific rules.

The documentation follows the same structure and style as existing settings docs and provides users with everything they need to effectively use this feature.


💻 View my workAbout Codegen

- Create comprehensive docs for organization-wide rules setting
- Add organization-rules.mdx to settings documentation
- Update docs.json navigation to include new page
- Document rule hierarchy and best practices
- Include examples and troubleshooting guidance
Copy link

codecov bot commented Jun 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor Author

codegen-sh bot commented Jun 1, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

@jayhack jayhack marked this pull request as ready for review June 1, 2025 22:21
@jayhack jayhack requested review from codegen-team and a team as code owners June 1, 2025 22:21
@jayhack jayhack merged commit 7cb4205 into develop Jun 1, 2025
25 of 26 checks passed
@jayhack jayhack deleted the codegen-bot/add-organization-rules-docs-1748809453 branch June 1, 2025 22:21
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.

1 participant