Skip to content

Commit 7800556

Browse files
committed
docs: consolidate getting started documentation
Rename onboarding-guide.md to getting-started.md for consistency across Socket repos. Update README and docs index to reference both the quick start (10 min) and detailed development guide, giving contributors clear entry points. Changes: - Rename docs/onboarding-guide.md → docs/getting-started.md - Update title from "Onboarding Guide" to "Getting Started" - Add quick start reference to main README Contributing section - Update docs/README.md to show both quick and detailed paths
1 parent 2f3bc75 commit 7800556

File tree

4 files changed

+11629
-6
lines changed

4 files changed

+11629
-6
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,10 @@ Supports version 2 format with `projectIgnorePaths` for excluding files from rep
100100

101101
## Contributing
102102

103-
**New to Socket CLI development?** Start with our [Getting Started Guide](docs/development/getting-started.md) for complete setup instructions.
103+
**New to Socket CLI development?**
104+
105+
- **Quick Start (10 min)**: [Getting Started Guide](docs/getting-started.md) — Essential setup and first contribution
106+
- **Detailed Guide**: [Development Getting Started](docs/development/getting-started.md) — Complete end-to-end onboarding
104107

105108
**Quick setup:**
106109

docs/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
## New to Socket CLI Development?
44

5-
**Start here:** [Getting Started Guide](development/getting-started.md)
5+
**Choose your path:**
66

7-
Complete end-to-end onboarding for new contributors:
7+
- **[Quick Start (10 min)](getting-started.md)** — Essential setup and first contribution
8+
- **[Detailed Guide](development/getting-started.md)** — Complete end-to-end onboarding with troubleshooting
9+
10+
The detailed guide includes:
811
- Prerequisites and installation
9-
- 5-minute quick start
1012
- Development workflow
1113
- Testing strategies
1214
- Troubleshooting guide

docs/onboarding-guide.md renamed to docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Onboarding Guide
1+
# Getting Started
22

3-
**New Contributor Quickstart** — Get started with Socket CLI development in 10 minutes.
3+
**Quick start guide** — Get started with Socket CLI development in 10 minutes.
44

55
---
66

0 commit comments

Comments
 (0)