Cursor rule

1---
2alwaysApply: true
3---
4 
5# Master Rules
6 
7This file serves as the central reference for all Cursor rules in the TypeScript Blackbook repository.
8This file makes it easier for the AI agent to discover rules when they are organized in folders.
9 
10## How to Use Rules
11 
12### For Project Understanding
13 
14- Use [project/overview.mdc](mdc:.cursor/rules/project/overview.mdc) when understanding the repository's purpose, audience, and core requirements
15- Use [project/repository_structure.mdc](mdc:.cursor/rules/project/repository_structure.mdc) when understanding or modifying the monorepo structure
16 
17### For Code Quality and Standards
18 
19- Use [guidelines/voice_and_tone.mdc](mdc:.cursor/rules/guidelines/voice_and_tone.mdc) when writing or editing any content
20- Use [guidelines/syntax_conventions.mdc](mdc:.cursor/rules/guidelines/syntax_conventions.mdc) when writing or editing markdown files
21- Use [guidelines/naming_conventions.mdc](mdc:.cursor/rules/guidelines/naming_conventions.mdc) when creating or updating files and folders
22- Use [guidelines/typescript_code_examples.mdc](mdc:.cursor/rules/guidelines/typescript_code_examples.mdc) when creating or editing TypeScript code examples
23- Use [guidelines/review_rubric.mdc](mdc:.cursor/rules/guidelines/review_rubric.mdc) when reviewing or validating content
24 
25### For Templates
26 
27- Use [templates/article_template.mdc](mdc:.cursor/rules/templates/article_template.mdc) when creating new articles
28- Use [templates/cursor_rules.mdc](mdc:.cursor/rules/templates/cursor_rules.mdc) when creating new cursor rule files
29 
30## Available Rules
31 
32### Project
33 
34Project structure and organization:
35 
36- [project/overview.mdc](mdc:.cursor/rules/project/overview.mdc) - Project overview, core principles, and fundamental requirements
37- [project/repository_structure.mdc](mdc:.cursor/rules/project/repository_structure.mdc) - Comprehensive guide to the TypeScript Blackbook repository structure
38 
39### Guidelines
40 
41Opinionated best practices on specific topics:
42 
43- [guidelines/voice_and_tone.mdc](mdc:.cursor/rules/guidelines/voice_and_tone.mdc) - Writing persona, tense, point of view, and style guidelines.
44- [guidelines/syntax_conventions.mdc](mdc:.cursor/rules/guidelines/syntax_conventions.mdc) - Markdown formatting standards and code block conventions.
45- [guidelines/naming_conventions.mdc](mdc:.cursor/rules/guidelines/naming_conventions.mdc) - Naming conventions for files, folders, and code elements.
46- [guidelines/typescript_code_examples.mdc](mdc:.cursor/rules/guidelines/typescript_code_examples.mdc) - Guidelines for writing TypeScript code examples in documentation.
47- [guidelines/review_rubric.mdc](mdc:.cursor/rules/guidelines/review_rubric.mdc) - Quality checklist and acceptance criteria for articles.
48 
49### Templates
50 
51Templates for the AI agent to use:
52 
53- [templates/article_template.mdc](mdc:.cursor/rules/templates/article_template.mdc) - Standard article template and structure for TypeScript Blackbook content
54- [templates/cursor_rules.mdc](mdc:.cursor/rules/templates/cursor_rules.mdc) - Template for creating new cursor rule files
55