Skip to content

Commit 7b2b447

Browse files
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>
1 parent b3e8662 commit 7b2b447

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ npx claude-conduct checkup -p ./src # Check specific directory
108108

109109
## What It Does
110110

111+
[⬆ Back to top](#table-of-contents)
112+
111113
Claude Conductor creates a structured documentation framework that:
112114

113115
- **Organizes** your project documentation into focused, interconnected modules
@@ -119,6 +121,8 @@ Claude Conductor creates a structured documentation framework that:
119121

120122
## Documentation Templates
121123

124+
[⬆ Back to top](#table-of-contents)
125+
122126
### Core Templates (Default)
123127
- **CONDUCTOR.md** - Master navigation hub and framework reference
124128
- **CLAUDE.md** - AI assistant guidance tailored to your project
@@ -141,6 +145,8 @@ All core templates plus:
141145

142146
## Installation Options
143147

148+
[⬆ Back to top](#table-of-contents)
149+
144150
### Option 1: npx (Recommended)
145151
```bash
146152
npx claude-conductor
@@ -198,6 +204,8 @@ Add to package.json:
198204

199205
## Features
200206

207+
[⬆ Back to top](#table-of-contents)
208+
201209
### Intelligent Codebase Analysis
202210

203211
#### Default Analysis (Fast - 2-3 seconds)
@@ -236,6 +244,8 @@ All default features plus:
236244

237245
## CLI Commands
238246

247+
[⬆ Back to top](#table-of-contents)
248+
239249
### Initialize Documentation (Default)
240250
```bash
241251
claude-conductor [options] [target-dir]
@@ -339,6 +349,8 @@ npx claude-conductor restore
339349

340350
## Example Output
341351

352+
[⬆ Back to top](#table-of-contents)
353+
342354
After running `npx claude-conductor`, you'll have:
343355

344356
```
@@ -373,6 +385,8 @@ your-project/
373385

374386
## How Your Project's ARCHITECTURE.md Will Look
375387

388+
[⬆ Back to top](#table-of-contents)
389+
376390
These are **EXAMPLES** showing how Claude Conductor populates ARCHITECTURE.md for a hypothetical React/Express project (not Claude Conductor's own dependencies):
377391

378392
### Example: ARCHITECTURE.md with Default Scan
@@ -406,6 +420,8 @@ These are **EXAMPLES** showing how Claude Conductor populates ARCHITECTURE.md fo
406420

407421
## Best Practices
408422

423+
[⬆ Back to top](#table-of-contents)
424+
409425
### Start Lean
410426
Begin with core templates and let your documentation grow organically:
411427
```bash
@@ -439,6 +455,8 @@ When working with Claude Code:
439455

440456
## Next Steps After Installation
441457

458+
[⬆ Back to top](#table-of-contents)
459+
442460
After running `npx claude-conductor`, your documentation templates contain placeholders. To populate them with your project details:
443461

444462
### Option 1: Quick Setup (Recommended)
@@ -485,17 +503,23 @@ This ensures Claude maintains a detailed development history in JOURNAL.md, whic
485503

486504
## Framework Philosophy
487505

506+
[⬆ Back to top](#table-of-contents)
507+
488508
1. **Modular > Monolithic** - Separate concerns into focused files
489509
2. **Practical > Theoretical** - Include real examples and patterns
490510
3. **Maintained > Stale** - Regular updates through development
491511
4. **Navigable > Comprehensive** - Easy to find what you need
492512

493513
## Contributing
494514

515+
[⬆ Back to top](#table-of-contents)
516+
495517
We welcome contributions! See our [Contributing Guide](https://github.com/superbasicstudio/claude-conductor/blob/main/CONTRIBUTING.md) for guidelines.
496518

497519
## Privacy & Security
498520

521+
[⬆ Back to top](#table-of-contents)
522+
499523
### Your Data Stays Private
500524

501525
**Claude Conductor is a completely offline tool that:**
@@ -536,6 +560,8 @@ For more details:
536560

537561
## License
538562

563+
[⬆ Back to top](#table-of-contents)
564+
539565
BSD 2-Clause © Super Basic Studio
540566

541567
---

0 commit comments

Comments
 (0)