chore(rules): update documentation structure and add new context files #34428
Conversation
- Enhanced CLAUDE.md with clearer guidance on project rules and documentation updates. - Introduced new rule files for documentation maintenance, frontend context, Java context, and testing context. - Removed outdated documentation files to streamline the rules directory. - Updated README.md to reflect the new structure and provide an index for easy navigation. This update improves clarity and accessibility of project rules and documentation practices.
❌ Issue Linking RequiredThis PR could not be linked to an issue. All PRs must be linked to an issue for tracking purposes. How to fix this:Option 1: Add keyword to PR body (Recommended - auto-removes this comment)
Why is this required?Issue linking ensures proper tracking, documentation, and helps maintain project history. It connects your code changes to the problem they solve.--- This comment was automatically generated by the issue linking workflow |
- Deleted `rule.md` to streamline the rules directory and eliminate redundancy. - This change supports the ongoing effort to enhance clarity and accessibility of project rules and documentation practices.
- Translated sections of the README.md from Spanish to English for better accessibility. - Improved formatting and clarity of rule types and current rules. - Enhanced best practices section to ensure clear guidance on rule creation and usage. - Updated references to official documentation for consistency.
nicobytes
requested review from
dcolina,
erickgonzalez,
nollymar and
spbolton
…ions - Removed outdated recommendations regarding file structure and merging documentation. - Clarified TypeScript standards section for better readability and consistency. - This update enhances the clarity and accessibility of frontend documentation.
There was a problem hiding this comment.
Pull request overview
This PR restructures and consolidates the project documentation and Cursor rules to improve clarity and reduce duplication. The changes transform documentation from scattered .md files into a cohesive system with a clear hierarchy: CLAUDE.md as the navigation hub, /docs/frontend/ for comprehensive standards, and .cursor/rules/ for concise, glob-based context.
Changes:
- Created comprehensive frontend documentation suite (TYPESCRIPT_STANDARDS.md, expanded TESTING_FRONTEND.md, rewritten STATE_MANAGEMENT.md focusing on NgRx Signal Store, and added docs/frontend/README.md as an index)
- Converted Cursor rules from
.mdto.mdcformat with proper frontmatter (globs, descriptions, alwaysApply flags) for better context loading - Consolidated and deduplicated documentation by replacing verbose cursor rules with concise reminders that reference
/docs/for details
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/frontend/TYPESCRIPT_STANDARDS.md | New comprehensive TypeScript standards (strict types, inference, unknown, as const, # private) |
| docs/frontend/TESTING_FRONTEND.md | Extensively updated with Spectator API reference, $ prefix conventions, and user-centric testing patterns |
| docs/frontend/STYLING_STANDARDS.md | Updated to prioritize PrimeFlex utilities and PrimeNG components over custom SCSS |
| docs/frontend/STATE_MANAGEMENT.md | Complete rewrite focusing on NgRx Signal Store with patchState, rxMethod, and tapResponse |
| docs/frontend/README.md | New index/navigation for all frontend docs with "when to load" guidance |
| docs/frontend/COMPONENT_ARCHITECTURE.md | Updated all examples to use $ prefix for signals, added template examples |
| docs/frontend/ANGULAR_STANDARDS.md | Enhanced with Angular best practices, accessibility requirements, and cross-references |
| CLAUDE.md | Minor update to reference .cursor/rules/README.md for Cursor users |
| .github/frontend.instructions.md | Expanded with Nx workspace context, file structure guidance, and clarified NgOptimizedImage usage |
| .cursor/rules/*.mdc | New concise context files (java-context, frontend-context, test-context, doc-updates, dotcms-guide, index) with proper frontmatter |
| .cursor/rules/README.md | New documentation explaining Cursor rule types and best practices |
| .cursor/rules/*.md (deleted) | Removed verbose .md files (typescript-context, test-context, maintenance-automation, java-context, dotcms-guide, documentation-maintenance) |
- Added detailed project structure to the dotCMS guide for better clarity on the organization of the codebase. - Removed the outdated index.mdc file, consolidating project navigation and critical reminders into the main guide. - This update enhances the documentation's usability and aligns with current project standards.
…xt documentation - Updated the test command syntax in frontend-context.mdc, test-context.mdc, and frontend.instructions.md to remove the unnecessary `testNamePattern` parameter. - This change enhances clarity and consistency across documentation for running tests in the Nx monorepo.
This update improves clarity and accessibility of project rules and documentation practices.