From 3dec1ee7b213b55f65345acca8b05314cf8142b9 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Fri, 21 Jan 2022 07:39:10 +0100 Subject: [PATCH] docs: remove emoji, add placeholder links to landing page. --- website/docs/user_guide/index.md | 22 ++++++++++++++++++---- website/sidebars.js | 8 ++++---- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/website/docs/user_guide/index.md b/website/docs/user_guide/index.md index 0eb5af89ea..65f10fc391 100644 --- a/website/docs/user_guide/index.md +++ b/website/docs/user_guide/index.md @@ -1,6 +1,6 @@ --- id: index -title: 📚 About the docs +title: About the docs slug: / sidebar_position: 1 --- @@ -27,14 +27,28 @@ New to Unleash? Not sure where to get started? The tutorials guide you through t Our how-to guides show you how to perform a number of common tasks that you'll want to do. Think of them as recipes. They are more advanced than the tutorials and assume you have some working knowledge of Unleash. -### Topic guides - -Topic guides discuss high-level concepts related to Unleash and provide extra background information and explanations around these concepts. +The guides are organized into the following topics: +- API [/how-to/api] +- Feature toggles, strategies, context [/how-to/general] +- Users and permissions [/how-to/permissions] +- SSO [/how-to/single-sign-on] ### Reference documentation The reference docs contain technical reference for Unleash and the API. Go here to find out how Unleash works and what configuration options are available. They're like an Unleash encyclopedia and assume you have a grip on key Unleash concepts. +The reference docs are organized into the following topics: +- Unleash concepts [/reference/concepts] +- APIs [/reference/api] +- Unleash SDKs [/reference/sdk] +- Deploy and manage unleash [/reference/deployment] +- Addons [/reference/addons] +- Integrations [/reference/integrations] + +### Topic guides + +Topic guides discuss high-level concepts related to Unleash and provide extra background information and explanations around these concepts. + ## Other resources and communities 💻 The core of Unleash is all open source and [hosted on GitHub](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash "Unleash on GitHub"). diff --git a/website/sidebars.js b/website/sidebars.js index 744b314880..b8f694716a 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -13,14 +13,14 @@ module.exports = { documentation: [ 'user_guide/index', { - '👶 First steps': [ + 'First steps': [ 'user_guide/unleash_overview', 'user_guide/important-concepts', 'user_guide/quickstart', ], }, { - label: '🛠 How-to guides', + label: 'How-to guides', type: 'category', collapsible: true, link: { @@ -52,7 +52,7 @@ module.exports = { ], }, { - label: '📖 Reference documentation', + label: 'Reference documentation', type: 'category', collapsible: true, items: [ @@ -186,7 +186,7 @@ module.exports = { ], }, { - '🧠 Topic guides': ['topics/a-b-testing'], + 'Topic guides': ['topics/a-b-testing'], }, ], };