Skip to content

Commit 018a0f2

Browse files
smeubanksmeubank
committed
feat: Restructure JavaScript cron monitoring documentation
- Transform overwhelming 275-line single page into focused method picker - Create separate pages for each integration approach: * UI Setup: Two-step process (create monitor + add notification code) * Automatic: Auto-instrumentation for node-cron/cron/node-schedule * Manual: Full SDK control with custom error handling * Advanced: Programmatic monitor management for CI/CD - Add comprehensive PRFAQ addressing real user confusion - Include decision framework to eliminate choice paralysis - Add redirect alerts for backward compatibility - Enhance troubleshooting with issue resolution - Add Cursor project rules and feature development workflow Addresses user feedback about confusing UI flow and overwhelming docs that showed 4+ methods without clear guidance on which to use.
1 parent 4b4614f commit 018a0f2

File tree

24 files changed

+6891
-263
lines changed

24 files changed

+6891
-263
lines changed

‎.cursor/project/README.md‎

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
# Project Documentation & Organization
2+
3+
## 🎯 Purpose
4+
5+
This directory serves as a flexible space for organizing project-specific documentation and monorepo structure information.
6+
7+
## 📂 Current Structure
8+
9+
```
10+
.cursor/project/
11+
├── README.md # This file - main organization guide
12+
├── dir-name/ # Flexible documentation collection space
13+
│ └── README.md # Instructions for organizing misc docs
14+
└── features/ # Feature development templates
15+
└── 001-template/ # PRFAQ → PRD → GTM workflow templates
16+
```
17+
18+
## 🗂️ Directory Purposes
19+
20+
### `/dir-name/` - Flexible Documentation Space
21+
22+
A versatile directory for organizing miscellaneous documentation. Can be used for:
23+
24+
- **Monorepo organization** - Document multiple apps/packages
25+
- **Domain-specific docs** - Group by business area (auth, payments, etc.)
26+
- **Operational guides** - Deployment, troubleshooting, runbooks
27+
- **Research notes** - Technology evaluations and experiments
28+
29+
**Usage:** Rename to match your project needs (e.g., `apps/`, `domains/`, `operations/`)
30+
31+
### `/features/` - Feature Development Templates
32+
33+
Contains templates for structured feature development:
34+
35+
- **PRFAQ** - Problem definition and solution validation
36+
- **PRD** - Technical requirements and specifications
37+
- **GTM** - Go-to-market strategy and launch planning
38+
- **Implementation** - Technical implementation guidance
39+
40+
**Usage:** Copy `001-template/` for each new feature (e.g., `002-auth-system/`)
41+
42+
## 📂 Recommended Structure Examples
43+
44+
### For Monorepo Projects
45+
46+
```
47+
.cursor/project/
48+
├── README.md
49+
├── apps/ # Rename dir-name to apps
50+
│ ├── web-frontend/
51+
│ ├── api-backend/
52+
│ ├── mobile-app/
53+
│ └── admin-dashboard/
54+
└── features/
55+
├── 001-template/
56+
├── 002-user-auth/
57+
└── 003-payment-system/
58+
```
59+
60+
### For Single Application Projects
61+
62+
```
63+
.cursor/project/
64+
├── README.md
65+
├── documentation/ # Rename dir-name to documentation
66+
│ ├── architecture/
67+
│ ├── operations/
68+
│ ├── research/
69+
│ └── troubleshooting/
70+
└── features/
71+
├── 001-template/
72+
├── 002-dashboard/
73+
└── 003-reporting/
74+
```
75+
76+
### For Domain-Driven Projects
77+
78+
```
79+
.cursor/project/
80+
├── README.md
81+
├── domains/ # Rename dir-name to domains
82+
│ ├── user-management/
83+
│ ├── billing/
84+
│ ├── analytics/
85+
│ └── notifications/
86+
└── features/
87+
├── 001-template/
88+
├── 002-user-profiles/
89+
└── 003-subscription-billing/
90+
```
91+
92+
## 📋 Documentation Types
93+
94+
### Essential Documents
95+
96+
- **README.md** - Overview and quick start for each component
97+
- **Architecture docs** - High-level system design and decisions
98+
- **Feature docs** - Detailed feature specifications and implementation notes
99+
- **Operations docs** - Deployment, monitoring, and maintenance guides
100+
101+
### Optional Documents
102+
103+
- **Research notes** - Technology evaluations and experiments
104+
- **Meeting notes** - Important architectural decisions and discussions
105+
- **Troubleshooting guides** - Common issues and solutions
106+
- **Performance analysis** - Benchmarks and optimization notes
107+
108+
## 🔧 Usage Guidelines
109+
110+
### Getting Started
111+
112+
1. **Rename `dir-name/`** to something meaningful for your project
113+
2. **Review the structure examples** above for inspiration
114+
3. **Create subdirectories** based on your organization needs
115+
4. **Use the feature templates** for structured development
116+
117+
### Creating New Documentation
118+
119+
1. **Start with a README** - Always create a README.md in new subdirectories
120+
2. **Use descriptive names** - Make directory and file names self-explanatory
121+
3. **Follow markdown standards** - Use consistent formatting and structure
122+
4. **Link between documents** - Create navigation between related docs
123+
124+
### Organizing Content
125+
126+
- **Group by domain** - Keep related documentation together
127+
- **Use consistent naming** - Follow kebab-case for directories and files
128+
- **Maintain hierarchy** - Don't go too deep (max 2-3 levels recommended)
129+
- **Regular cleanup** - Archive or remove outdated documentation
130+
131+
## 📝 Markdown Best Practices
132+
133+
### File Naming Convention
134+
135+
```
136+
feature-name.md # Use kebab-case
137+
api-documentation.md # Descriptive names
138+
troubleshooting-guide.md # Clear purpose
139+
```
140+
141+
### Document Structure
142+
143+
```markdown
144+
# Document Title
145+
146+
## 🎯 Purpose
147+
148+
Brief overview of what this document covers
149+
150+
## 📋 Content
151+
152+
Main content sections with clear headings
153+
154+
## 🔗 Related Documents
155+
156+
Links to related documentation
157+
158+
## 📅 Last Updated
159+
160+
Date and reason for last update
161+
```
162+
163+
### Internal Linking
164+
165+
```markdown
166+
<!-- Link to other project docs -->
167+
168+
[Architecture Overview](./dir-name/architecture/README.md)
169+
170+
<!-- Link to features -->
171+
172+
[User Authentication Feature](./features/002-auth-system/README.md)
173+
174+
<!-- Link to main cursor rules -->
175+
176+
[Coding Guidelines](../rules/coding-guidelines.md)
177+
```
178+
179+
## 🎯 Integration with Cursor Rules
180+
181+
This project documentation works alongside the main cursor rules:
182+
183+
- **Rules directory** (`../rules/`) - Contains AI assistant guidelines and coding standards
184+
- **Project directory** (`./`) - Contains project-specific documentation and organization
185+
- **Feature templates** - Use the feature development workflow from the rules
186+
187+
## 📋 Maintenance
188+
189+
### Regular Tasks
190+
191+
- [ ] Review and update documentation quarterly
192+
- [ ] Remove outdated documents and links
193+
- [ ] Ensure all directories have README files
194+
- [ ] Check that links are working and up-to-date
195+
- [ ] Archive completed features or deprecated components
196+
197+
### When Adding New Components
198+
199+
- [ ] Create a new subdirectory with descriptive name
200+
- [ ] Add README.md explaining the component
201+
- [ ] Link to/from other related documentation
202+
- [ ] Update this main README if adding new patterns
203+
204+
---
205+
206+
> 💡 **Tip**: This structure is flexible - adapt it to your project's needs. The key is maintaining clear organization and keeping documentation close to the code it describes.

0 commit comments

Comments
 (0)