You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add 'Back to top' navigation links to README sections
- Add ⬆ Back to top links after each major section
- Links point to the Table of Contents for easy navigation
- Improves document usability for long README
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Claude Conductor creates a structured documentation framework that:
112
114
113
115
-**Organizes** your project documentation into focused, interconnected modules
@@ -119,6 +121,8 @@ Claude Conductor creates a structured documentation framework that:
119
121
120
122
## Documentation Templates
121
123
124
+
[⬆ Back to top](#table-of-contents)
125
+
122
126
### Core Templates (Default)
123
127
-**CONDUCTOR.md** - Master navigation hub and framework reference
124
128
-**CLAUDE.md** - AI assistant guidance tailored to your project
@@ -141,6 +145,8 @@ All core templates plus:
141
145
142
146
## Installation Options
143
147
148
+
[⬆ Back to top](#table-of-contents)
149
+
144
150
### Option 1: npx (Recommended)
145
151
```bash
146
152
npx claude-conductor
@@ -198,6 +204,8 @@ Add to package.json:
198
204
199
205
## Features
200
206
207
+
[⬆ Back to top](#table-of-contents)
208
+
201
209
### Intelligent Codebase Analysis
202
210
203
211
#### Default Analysis (Fast - 2-3 seconds)
@@ -236,6 +244,8 @@ All default features plus:
236
244
237
245
## CLI Commands
238
246
247
+
[⬆ Back to top](#table-of-contents)
248
+
239
249
### Initialize Documentation (Default)
240
250
```bash
241
251
claude-conductor [options] [target-dir]
@@ -339,6 +349,8 @@ npx claude-conductor restore
339
349
340
350
## Example Output
341
351
352
+
[⬆ Back to top](#table-of-contents)
353
+
342
354
After running `npx claude-conductor`, you'll have:
343
355
344
356
```
@@ -373,6 +385,8 @@ your-project/
373
385
374
386
## How Your Project's ARCHITECTURE.md Will Look
375
387
388
+
[⬆ Back to top](#table-of-contents)
389
+
376
390
These are **EXAMPLES** showing how Claude Conductor populates ARCHITECTURE.md for a hypothetical React/Express project (not Claude Conductor's own dependencies):
377
391
378
392
### Example: ARCHITECTURE.md with Default Scan
@@ -406,6 +420,8 @@ These are **EXAMPLES** showing how Claude Conductor populates ARCHITECTURE.md fo
406
420
407
421
## Best Practices
408
422
423
+
[⬆ Back to top](#table-of-contents)
424
+
409
425
### Start Lean
410
426
Begin with core templates and let your documentation grow organically:
411
427
```bash
@@ -439,6 +455,8 @@ When working with Claude Code:
439
455
440
456
## Next Steps After Installation
441
457
458
+
[⬆ Back to top](#table-of-contents)
459
+
442
460
After running `npx claude-conductor`, your documentation templates contain placeholders. To populate them with your project details:
443
461
444
462
### Option 1: Quick Setup (Recommended)
@@ -485,17 +503,23 @@ This ensures Claude maintains a detailed development history in JOURNAL.md, whic
485
503
486
504
## Framework Philosophy
487
505
506
+
[⬆ Back to top](#table-of-contents)
507
+
488
508
1.**Modular > Monolithic** - Separate concerns into focused files
489
509
2.**Practical > Theoretical** - Include real examples and patterns
490
510
3.**Maintained > Stale** - Regular updates through development
491
511
4.**Navigable > Comprehensive** - Easy to find what you need
492
512
493
513
## Contributing
494
514
515
+
[⬆ Back to top](#table-of-contents)
516
+
495
517
We welcome contributions! See our [Contributing Guide](https://github.com/superbasicstudio/claude-conductor/blob/main/CONTRIBUTING.md) for guidelines.
496
518
497
519
## Privacy & Security
498
520
521
+
[⬆ Back to top](#table-of-contents)
522
+
499
523
### Your Data Stays Private
500
524
501
525
**Claude Conductor is a completely offline tool that:**
0 commit comments