From 37d69735394ad7751d269524020c603c6d9c925d Mon Sep 17 00:00:00 2001 From: Dee <152322737+dee-cahoon@users.noreply.github.com> Date: Wed, 3 Jan 2024 11:27:07 -0500 Subject: [PATCH] Added missing pages & descriptions to index.md (#117) * 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 --- docs/index.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 8a4553a..c8aba21 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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! \ No newline at end of file +### Welcome aboard, and happy exploring!