Skip to content

Commit 7a6d408

Browse files
authored
Docs/nextra docs (#158)
* docs: remove typedoc references from documentation - Remove TypeDoc specific mentions from CLAUDE.md - Rename pattern file from jsdoc-typedoc to jsdoc - Update documentation generation references - Simplify JSDoc documentation guidance * feat: remove typedoc dependencies and configuration - Remove @blackwych/typedoc-plugin-categorized-hierarchy-theme - Remove typedoc-plugin-extras and typedoc-theme-hierarchy packages - Remove typedoc package and configuration - Update build:docs script to use placeholder command - Remove TypeDoc section from CONTRIBUTING.md * chore: init docs * chore: unconscious commit 🐋 * chore: update commands * chore: unconscious commit 🐋 * feat: enhance claude commands system - Update plan-resolve.md with direct file modification workflow - Improve spec.md with interactive discovery process - Recreate plan-create.md command * refactor: remove Next.js docs structure Remove all Next.js related documentation files to prepare for Nextra v4 migration * chore: add nextra v4 documentation packages Add nextra and nextra-theme-docs for new documentation system * feat: add nextra v4 documentation plan and pages - Add strategic plan for Nextra v4 documentation system migration - Add initial pages structure for self-referencing system * chore: add docs * chore: unconscious commit 🎲 * chore: remove doc-publish workflow Deleted the GitHub Actions workflow for documentation publishing * chore: update documentation app icons - Remove old public favicon files - Update apple-icon.png with new design - Update icon.svg with enhanced graphics * feat: add lucide-react icons and update project configuration - Add lucide-react dependency for modern icon system - Update favicon and global styles for documentation - Configure development environment settings * refactor: remove old documentation structure - Remove unused expo-release-it documentation files - Clean up obsolete usage and config sections - Prepare for React Native Naver Map documentation structure * feat: add custom Card component with Lucide icons - Create reusable Card and Cards components with modern design - Integrate Lucide React icons for enhanced visual appeal - Support hover animations, dark mode, and responsive layout - Replace default Nextra Cards with custom implementation * docs: implement complete React Native Naver Map documentation - Restructure documentation for React Native Naver Map library - Add comprehensive installation guides for Android, iOS, and Expo - Create detailed component documentation with examples - Include getting started guide with step-by-step instructions - Add API reference and guides sections - Integrate custom Card components with Lucide icons - Support Nextra components (Tabs, Callout, Steps) for enhanced UX * chore: unconscious commit 🎲
1 parent 17b0fa7 commit 7a6d408

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+8702
-512
lines changed

.claude/commands/plan-create.md

Lines changed: 120 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plan Create - Interactive Implementation Planning System
22

3-
Create comprehensive implementation plans through deep interactive dialogue.
3+
Create comprehensive development plans markdown content through deep interactive dialogue and run cli with that content.
44

55
**Usage**: `/plan-create`
66

@@ -23,128 +23,146 @@ EOF
2323

2424
## Interactive Deep-Dive Process
2525

26-
### Step 1: Initial Scope Understanding (MANDATORY)
26+
## Interactive Planning Process
2727

28-
**CRITICAL: Only proceed to Step 4 (CLI execution) after completing Steps 1-3 dialogue. Do not use implementation tools during discovery phase.**
28+
**Simple Workflow:**
29+
1. Ask what the user wants to plan
30+
2. Have a conversation to understand details
31+
3. Create the plan with CLI command
2932

30-
When user types `/plan-create`, the agent MUST first ask:
33+
**MANDATORY: Infinite Interactive Dialogue Process**
3134

35+
**Start by asking:**
3236
```
33-
I'll help you create a comprehensive implementation plan through detailed conversation.
37+
What would you like to plan?
3438
35-
First, I need to understand what you're planning to implement:
36-
37-
**What would you like to plan?**
38-
39-
Please describe in detail:
40-
- The feature, fix, or system you want to implement
41-
- The problem it solves or requirement it fulfills
42-
- Your current technical environment and constraints
43-
- Any specific approaches or technologies you're considering
44-
45-
The more detail you provide about the implementation context and requirements, the better I can help create a plan that perfectly fits your project's needs and constraints.
46-
47-
Take your time - this initial context is crucial for creating an actionable implementation plan.
39+
Please describe:
40+
- What you want to implement
41+
- The problem it solves
42+
- Your current tech setup
4843
```
4944

50-
### Step 2: Extensive Interactive Discovery
51-
52-
Based on the user's response, engage in a **fully interactive, extensive dialogue** to understand every implementation aspect:
53-
54-
**Technical Context Deep-Dive:**
55-
- Current tech stack and framework versions
56-
- Existing architecture and patterns
57-
- Database and infrastructure setup
58-
- Authentication and security requirements
59-
- Performance and scalability needs
60-
- Testing and deployment processes
61-
62-
**Implementation Requirements Discovery:**
63-
- Specific functionality and user stories
64-
- Technical design and architecture decisions
65-
- Files and modules that need changes
66-
- Dependencies and integrations required
67-
- Error handling and edge cases
68-
- Success metrics and validation criteria
69-
70-
### Step 3: Implementation Planning
71-
72-
After thorough discovery, determine the plan structure based on implementation type:
73-
74-
**For New Features:**
75-
- User stories and acceptance criteria
76-
- Technical architecture and design patterns
77-
- Database schema changes
78-
- API endpoints and interfaces
79-
- Frontend components and user flows
80-
- Integration points and data flow
81-
- Testing strategy and scenarios
82-
83-
**For Bug Fixes:**
84-
- Root cause analysis and diagnosis
85-
- Impact assessment and affected systems
86-
- Fix strategy and implementation approach
87-
- Testing and validation requirements
88-
- Deployment and rollback considerations
89-
90-
**For Performance/Refactoring:**
91-
- Current bottlenecks and target metrics
92-
- Refactoring strategy and migration steps
93-
- Backward compatibility considerations
94-
- Monitoring and observability improvements
95-
- Rollout and validation approach
96-
97-
### Step 4: Create Implementation Plan
98-
99-
Execute CLI command to create the plan:
45+
**CRITICAL: After every user response, analyze what implementation details are still missing and ask deeper questions. NEVER stop asking until you know exactly how to implement everything.**
46+
47+
**Self-Assessment Questions - Ask yourself after each user response:**
48+
- "What files exactly need to be created or modified?"
49+
- "What specific code changes are required?"
50+
- "What dependencies need to be installed?"
51+
- "What configuration changes are needed?"
52+
- "How will this integrate with existing code?"
53+
- "What testing approach should be used?"
54+
55+
**Continuous Implementation Deep-Dive Pattern:**
56+
- If user says "add authentication" → Ask: Which files handle auth? What database changes? JWT or sessions? Middleware needed? Registration flow? Password reset?
57+
- If user says "improve performance" → Ask: What specific bottlenecks? Which components are slow? Database queries? Frontend rendering? API endpoints? Caching strategy?
58+
- If user says "refactor components" → Ask: Which exact components? What's the new structure? How to maintain backwards compatibility? Migration steps?
59+
60+
**Keep Digging Until You Know:**
61+
- Exact file paths that need changes
62+
- Specific functions/components to create/modify
63+
- Complete dependency list with versions
64+
- Step-by-step implementation sequence
65+
- All configuration changes required
66+
- Comprehensive testing strategy
67+
- Success criteria with measurable outcomes
68+
69+
**Signs You Need More Implementation Details:**
70+
- You don't know exact file paths → ASK MORE
71+
- You're unsure about code structure → ASK MORE
72+
- Dependencies are unclear → ASK MORE
73+
- Implementation steps are vague → DRILL DOWN
74+
- Testing approach is undefined → ASK MORE
75+
- You can't write specific todo items → ASK MORE
76+
77+
**ONLY create the plan when you can confidently say: "I know exactly which files to modify, what code to write, what dependencies to install, and how to test everything."**
78+
79+
After complete implementation understanding, create the plan using:
10080

10181
```bash
10282
npx -y cc-self-refer plan create "<plan-title>" <<'EOF'
103-
<comprehensive-plan-content>
83+
<plan-content>
10484
EOF
10585
```
10686

107-
### Interactive Q&A Strategy
108-
109-
**Start broad, then get specific based on answers:**
110-
111-
Example for "implement rate limiting":
112-
```
113-
Round 1 - Context:
114-
- What's your API framework?
115-
- Do you have Redis available?
116-
- Current traffic patterns?
117-
118-
Round 2 - Requirements (based on Round 1):
119-
- Rate limit thresholds?
120-
- Different limits per user type?
121-
- Which endpoints to protect?
122-
123-
Round 3 - Implementation:
124-
- User identification method?
125-
- Response when exceeded?
126-
- Monitoring needs?
127-
128-
[Continue until all details clear]
129-
```
130-
13187
## Plan Document Template
13288

89+
**IMPORTANT: the following implementation details are just example. The content of implementation section will vary depend on the plan requirement. **
90+
91+
======================TEMPLATE=====================
13392
```markdown
13493
# <Task Name>
13594

13695
## Overview
13796
[Concise description of what needs to be done, why it's needed, and expected outcome]
13897

13998
## Implementation
140-
[Detailed technical implementation including:
141-
- Framework/library choices (without version, assume latest versions'll be used)
142-
- Specific files to create/modify with exact paths
143-
- Code snippets or pseudo-code for core logic
144-
- Package dependencies to install
145-
- API endpoints or interfaces to implement
146-
- Database schema changes if needed
147-
- Configuration and environment variables]
99+
100+
### Required Content
101+
102+
103+
**Technical Stack & Dependencies**
104+
- Framework: [React, Vue, Node.js, etc.]
105+
- Language & Version: [TypeScript 5.x, Node 18+, etc.]
106+
- Package Manager: [npm, pnpm, yarn]
107+
- Required Dependencies: List exact package names and versions
108+
- New Dependencies to Install: Exact commands to run
109+
```bash
110+
npm install package-name@version
111+
pnpm add package-name
112+
```
113+
114+
**Architecture & File Structure **
115+
- Directory Structure: Show exact paths where files will be created/modified
116+
- Component/Module Design: Describe the main classes, functions, or components
117+
- Data Flow: How data moves through the system
118+
- State Management: Redux, Context, or other patterns used
119+
120+
**Implementation Steps **
121+
1. **Setup Phase**
122+
- Environment configuration
123+
- Dependency installation commands (exact CLI commands)
124+
- Database migration commands (if needed)
125+
126+
2. **Core Development**
127+
- File Creation: List all new files to create with their exact paths
128+
- File Modification: List existing files to modify with specific functions/sections
129+
- Code Patterns: Reference existing patterns or describe new ones
130+
131+
3. **Integration Phase**
132+
- API Integration: Exact endpoint URLs, request/response formats
133+
- Component Integration: How new components connect to existing ones
134+
- Testing Integration: Test file locations and testing commands
135+
136+
4. **Validation & Deployment**
137+
- Build Commands: `npm run build`, `pnpm build`, etc.
138+
- Test Commands: `npm test`, `pnpm test`, `npm run e2e`, etc.
139+
- Linting Commands: `npm run lint`, `pnpm lint`, etc.
140+
141+
**Configuration Details **
142+
- Environment Variables: Exact variable names and example values
143+
- Config Files: Which files need modification (tsconfig.json, package.json, etc.)
144+
- Build Settings: Webpack, Vite, or other build tool configurations
145+
146+
**External References **
147+
- Documentation Links: Include exact URLs for libraries, APIs, or frameworks
148+
- CLI Commands from Docs: Copy exact commands from documentation
149+
```bash
150+
# Example: From Next.js docs
151+
npx create-next-app@latest my-app --typescript --tailwind
152+
```
153+
- Code Examples: Include relevant code snippets from documentation
154+
155+
**Error Handling & Edge Cases (에러 처리 및 엣지 케이스)**
156+
- Common Error Scenarios: What could go wrong and how to handle it
157+
- Validation Rules: Input validation, data validation requirements
158+
- Fallback Strategies: What to do when primary approach fails
159+
160+
**Performance Considerations (성능 고려사항)**
161+
- Optimization Strategies: Lazy loading, caching, bundling
162+
- Monitoring: How to measure success (metrics, logging)
163+
- Scalability: How the solution handles growth
164+
165+
148166

149167
## Todo List
150168
- [ ] [Specific action item 1]
@@ -165,48 +183,7 @@ Round 3 - Implementation:
165183
- Docs: [External documentation link if needed]
166184
```
167185
168-
### Example Plan
169-
170-
```markdown
171-
# Fix Memory Leak in WebSocket Handler
172-
173-
## Overview
174-
Resolve memory leak causing server crashes after 24 hours of operation. Event listeners are not being properly cleaned up on disconnect.
175-
176-
## Implementation
177-
**Root Cause:** Event listeners not removed on socket disconnect
178-
**Affected Service:** WebSocket server (`src/services/websocket.ts`)
179-
180-
**Fix approach:**
181-
```typescript
182-
// Add cleanup in disconnect handler
183-
socket.on('disconnect', () => {
184-
socket.removeAllListeners();
185-
clearInterval(heartbeatInterval);
186-
delete activeSockets[socket.id];
187-
});
188-
```
189-
190-
**Memory profiling:**
191-
- Use Chrome DevTools for heap snapshots
192-
- Monitor with `process.memoryUsage()`
193-
194-
## Todo List
195-
- [ ] Add memory profiling logs
196-
- [ ] Implement proper cleanup handlers
197-
- [ ] Test with connection stress tool
198-
- [ ] Monitor for 48 hours in staging
199-
- [ ] Deploy fix to production
200-
201-
## Success Criteria
202-
- [ ] Memory usage stable over 48 hours
203-
- [ ] No orphaned event listeners in heap dumps
204-
- [ ] Server handles 10k connect/disconnect cycles
205-
206-
## References
207-
- Page #23: Previous WebSocket issues
208-
- Pattern #7: Resource cleanup patterns
209-
```
186+
======================TEMPLATE END=====================
210187
211188
### Q&A Completion Checklist
212189
@@ -232,14 +209,6 @@ socket.on('disconnect', () => {
232209
233210
**Keep it practical:** Include only what's needed for execution. Skip sections if they don't apply.
234211
235-
## Key Principles
236-
237-
1. **Deep Discovery Through Dialogue** - Have extensive conversations to understand every implementation detail
238-
2. **Adaptive Questioning** - Each question builds on previous answers to go deeper
239-
3. **Comprehensive Planning** - Don't stop until all technical and business requirements are clear
240-
4. **Actionable Plans** - Create specific, implementable plans with clear steps
241-
5. **Context-Aware** - Consider existing codebase patterns and constraints
242-
243212
## Output Characteristics
244213
245214
The implementation plans created should:

.claude/commands/plan-resolve.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ Load a strategic plan and systematically work through all todos until completion
44

55
**Usage**: `/plan-resolve <id|keyword>`
66

7+
## ⚠️ CRITICAL: Direct Plan File Modification Required
8+
9+
**This command requires direct modification of the original plan file in `.claude/plans/` directory:**
10+
11+
1. **TODO Checkboxes**: Mark completed todos with `[x]` directly in the plan file
12+
2. **Success Criteria**: Update success criteria checkboxes `[x]` as they are achieved
13+
3. **File Location Display**: The `plan view` command shows the exact file path for direct editing
14+
4. **Real-time Progress**: Check off items in the actual plan file to track progress
15+
16+
**Workflow Pattern:**
17+
- Load plan with `npx cc-self-refer plan view <id>` (shows file location)
18+
- Edit the plan file directly: `.claude/plans/001-example-plan.md`
19+
- Check off `- [x]` completed todos and success criteria as you complete them
20+
- Use the plan file as your live progress tracker throughout implementation
21+
722
## Purpose
823

924
This command facilitates comprehensive execution of strategic plans by:

0 commit comments

Comments
 (0)