Skip to content

Commit 75c8893

Browse files
committed
docs: highlight getting started guide in README
Add prominent hero section directing new contributors to the Getting Started guide. This improves discoverability of the comprehensive onboarding documentation.
1 parent ace8a6a commit 75c8893

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
# Socket CLI Documentation
22

3-
## Organization
3+
## New to Socket CLI Development?
4+
5+
**Start here:** [Getting Started Guide](development/getting-started.md)
6+
7+
Complete end-to-end onboarding for new contributors:
8+
- Prerequisites and installation
9+
- 5-minute quick start
10+
- Development workflow
11+
- Testing strategies
12+
- Troubleshooting guide
13+
14+
## Documentation Organization
415

516
📚 **[Documentation Organization Guide](documentation-organization.md)** - Complete guide to Socket CLI's 3-tier documentation hierarchy
617

18+
### Categories
19+
720
- **architecture/** - System design documents and flow diagrams
821
- **build/** - Node.js build system and patching documentation
922
- **configuration/** - Shared configuration architecture

0 commit comments

Comments
 (0)