Skip to content

Overhaul guidelines#23

Open
luke-hagar-sp wants to merge 14 commits intomainfrom
overhaul
Open

Overhaul guidelines#23
luke-hagar-sp wants to merge 14 commits intomainfrom
overhaul

Conversation

@luke-hagar-sp
Copy link
Copy Markdown

No description provided.

LukasParke and others added 14 commits December 22, 2025 21:33
…ment and PDF export. Update .gitignore to exclude debug logs. Introduce new JSON and YAML files for rules and reviews.
…e global.css for background gradient consistency and remove unused CSS rules.
…-core, fumadocs-mdx, fumadocs-ui to versions 16.3.2, 14.2.2, and 16.3.2 respectively; upgrade next to 16.1.1 and puppeteer to 24.34.0.
- Updated `CopyRuleLinkButton` to conditionally show labels based on the `showLabel` prop.
- Enhanced `ExternalDocs` component to improve layout and styling.
- Introduced a new `Implementation` component for better handling of implementation links.
- Refined `RuleHeader` to integrate the new `Implementation` component and streamline the display of external documentation.
- Updated various rules in the documentation to improve clarity and consistency, including changes to titles and intents for better readability.
- Adjusted import paths in `next-env.d.ts` for development compatibility.
- Modified `.gitignore` to exclude the `node_modules` directory correctly.
- Added `RulesIndex` component to display and filter rules dynamically.
- Enhanced `RuleHeader` component to include a level badge for better visual representation of rule severity.
- Updated `next.config.mjs` to set output to 'standalone' for improved deployment.
- Created `railpack.json` for deployment configuration.
- Removed obsolete `tsconfig.tsbuildinfo` file and several outdated guide documents to streamline the project.
- Updated various documentation files to reflect changes in structure and content, including renaming sections for clarity.
- Introduced a new `RuleId` component to display rule IDs.
- Enhanced `ExternalDocs` and `Implementation` components with improved styling and structure.
- Updated `RuleHeader` to conditionally render external documentation and implementation links based on their availability.
- Adjusted layout for better visual hierarchy and spacing.
New rules filling identified gaps:
- #310 Enforce Tenant Data Isolation in Responses (MUST)
- #416 Return 406 for Unsupported Accept Headers (MUST)
- #417 Document HEAD and OPTIONS Method Support (SHOULD)
- #418 Classify Error Retryability (MUST)
- #606 Include Pagination Links in Collection Responses (SHOULD)
- #219 Annotate Enum Extensibility (SHOULD)
- #711 Specify PATCH Content Type and Null Semantics (MUST)

Supporting updates:
- Expanded idempotency-and-retries guide with retry classification
  table, backoff pseudocode, and server signaling patterns
- Added pagination link examples to pagination-recipes appendix
- Updated #403 baseline status codes (406, 502, 503, 504)
- Added cross-references from #401→#711 and #202→#219
- Added all 7 new rules to TESTABLE_RULES.md with priority lists
- Regenerated public/rules.json (122 rules)

Simplified all 122 rules across 9 rule files:
- Removed verbose rationale/motivation paragraphs
- Converted dense prose to scannable bullet points
- Kept all examples, code blocks, and related-rule links
- No rules removed or IDs/titles/levels changed

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Added a new script command `rule-links:validate` in `package.json` to validate rule links.
- Updated documentation to include a reference to the new `Breaking change reference` in appendices.
- Enhanced existing appendices with additional context and links for better navigation and clarity.
- Made minor adjustments to various rules for consistency and improved readability.
- Deleted the `rules_bands_migration` and `rules_renumber+modernize` plans as they are no longer relevant.
- These plans included details on consolidating rules into numeric bands and modernizing existing rules, which have been superseded by new strategies and implementations.
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.

2 participants