Skip to content

Commit

Permalink
Added missing pages & descriptions to index.md (#117)
Browse files Browse the repository at this point in the history
* Added missing pages & descriptions to index.md

Not all scarf-docs pages were included in the index list. Added and provided descriptions for the missing pages. Re-ordered based on logical progression of set-up and usage of data.

* Update docs/index.md

* Update docs/index.md

---------

Co-authored-by: Avi Press <[email protected]>
  • Loading branch information
dee-cahoon and aviaviavi authored Jan 3, 2024
1 parent 0c6a791 commit 37d6973
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,19 @@ Scarf provides open-source software maintainers with deep insights about their p

## Documentation Sections Overview

1. **[Quick Start](/quick-start):** Jumpstart your journey with Scarf. A concise guide to get you up and running with our platform quickly.
2. **[Packages](/packages):** Delve into the specifics of working with various package types, such as Docker, npm, Python, Hackage, and more. Learn about API Endpoints, Custom Events, Helm Charts, and Repository details.
1. **[Getting Started Checklist](/getting-started-checklist):** Preview the high-level Scarf set up process.
2. **[Quick Start](/quick-start):** Jumpstart your journey with Scarf. A concise guide to get you up and running with our platform quickly.
3. **[Scarf Gateway](/gateway):** Understand the nuances of Scarf's secure and powerful gateway.
4. **[Scarf SDKs](/package-analytics):** Discover how our Software Development Kits (SDKs) can accelerate your development process.
5. **[Documentation Insights (Pixels)](/web-traffic):** Uncover insights about your product's usage through Scarf's innovative pixel tracking.
6. **[Organizations](/organizations):** Learn how to manage and collaborate with your teams within Scarf's platform.
7. **[Data Export](/data-export):** Export your data for customized analysis. Explore the potential of data manipulation to suit your needs.
8. **[API Docs](https://api-docs.scarf.sh/v2.html):** Understand the capabilities of a specific API version and its available endpoints.
4. **[Organizations](/organizations):** Learn how to manage and collaborate with your teams within Scarf's platform.
5. **[Packages](/packages):** Delve into the specifics of working with various Scarf package types, such as Docker, Helm, npm, Python, and more.
6. **[Scarf SDKs](/package-analytics):** Discover how our Software Development Kits (SDKs) can accelerate your development process.
7. **[Documentation Insights (Pixels)](/web-traffic):** Uncover insights about your product's usage and onboarding through Scarf's cookie-free pixel tracking.
8. **[Open Source Qualified Leads (OQLs)](/oql):** Identify organizations and individuals that have engaged with your OSS.
9. **[Open Source Adoption Funnel Stages](/funnel-stages):** Understand the level of engagement of potential leads.
10. **[Data Export](/data-export):** Export your data for customized analysis. Explore the potential of data manipulation to suit your needs.
11. **[User Guide & Best Practices](/user_best_practices):** Make a plan to use the data uncovered in your OQLs.
12. **[Troubleshooting](/troubleshooting):** Find solutions to common issues and questions.
13. **[API Docs](https://api-docs.scarf.sh/v2.html):** Understand the capabilities of a specific API version and its available endpoints.

## Contribution

Expand All @@ -25,4 +30,4 @@ For engaging discussions, interactive Q&A sessions, and to meet our dynamic comm

Stay updated with Scarf's system status and uptime on our status page [here](https://status.scarf.sh).

### Welcome aboard, and happy exploring!
### Welcome aboard, and happy exploring!

0 comments on commit 37d6973

Please sign in to comment.