docs: add 18 ESLint-style rule example pages - #90
Merged
Conversation
CLAUDE.md: replace command table, ADR list, and pinned versions with references to src/commands/, .archgate/adrs/, and .prototools. README.md: remove commands table and CI section, defer to docs site. Homepage (en + pt-br): replace "Six ADRs" with open-ended text and link to the ADRs directory on GitHub.
Restructure the rule examples documentation: - Split inline examples out of writing-rules.mdx into dedicated pages - Convert common-rule-patterns.mdx into a categorized index page - Add 18 individual rule pages (EN + PT-BR = 36 files) covering: dependency management, import restrictions, file structure, code quality, database schema, and architecture boundaries - Each page follows ESLint-style format: rule details, incorrect/correct code examples, full .rules.ts implementation, when to use/not use - Use Starlight autogenerate for the Examples sidebar section - Real-world examples sourced from archgate, money-sync, and stavanger-challenge repositories
Deploying archgate-cli with
|
| Latest commit: |
7c9e32b
|
| Status: | ⚡️ Build in progress... |
rhuanbarreto
added a commit
that referenced
this pull request
Mar 20, 2026
* docs: remove hardcoded versions and counts, point to source files CLAUDE.md: replace command table, ADR list, and pinned versions with references to src/commands/, .archgate/adrs/, and .prototools. README.md: remove commands table and CI section, defer to docs site. Homepage (en + pt-br): replace "Six ADRs" with open-ended text and link to the ADRs directory on GitHub. * docs: add 18 individual ESLint-style rule example pages Restructure the rule examples documentation: - Split inline examples out of writing-rules.mdx into dedicated pages - Convert common-rule-patterns.mdx into a categorized index page - Add 18 individual rule pages (EN + PT-BR = 36 files) covering: dependency management, import restrictions, file structure, code quality, database schema, and architecture boundaries - Each page follows ESLint-style format: rule details, incorrect/correct code examples, full .rules.ts implementation, when to use/not use - Use Starlight autogenerate for the Examples sidebar section - Real-world examples sourced from archgate, money-sync, and stavanger-challenge repositories * docs: regenerate llms-full.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
common-rule-patterns.mdxinto a categorized index page linking to 18 individual rule pages.rules.tsimplementation, when to use it, when not to use itautogeneratefor the Examples sidebar sectionRule pages by category
no-unapproved-deps,version-catalog,monorepo-task-runnerno-banned-imports,no-banned-api,wrapper-enforcementkebab-case-filenames,no-barrel-files,test-file-coverage,component-pairingno-todo-comments,no-emoji-in-output,max-file-length,page-component-constraintsdatabase-audit-fieldsrequired-export-pattern,openapi-routes,clean-architecture-layersTest plan
bun run validatepasses (lint, typecheck, format, tests, ADR check, build)docssite builds successfully (73 pages indexed)