1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00

docs: make top-level categories open by default, re-order references

This commit is contained in:
Thomas Heartman 2022-01-26 11:51:35 +01:00
parent f62a65a23a
commit ee55f6a9fb
2 changed files with 45 additions and 43 deletions

View File

@ -45,12 +45,12 @@ The guides are organized into the following categories:
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)
- [API documentation](/api)
- [Unleash SDKs](/sdks)
- [Deploy and manage unleash](/deploy)
- [Addons](/addons)
- [Integrations](/integrations)
- [API documentation](/api)
- [Unleash Client SDKs](/sdks)
- [Deployment and management of Unleash](/deploy)
- [Integrations with other systems](/integrations)
- [Unleash concepts](/reference/concepts)
### Topic guides

View File

@ -15,6 +15,7 @@ module.exports = {
{
label: 'First steps and tutorials',
type: 'category',
collapsed: false,
link: {
type: 'generated-index',
title: 'First steps',
@ -29,8 +30,8 @@ module.exports = {
},
{
label: 'How-to guides',
collapsed: false,
type: 'category',
collapsible: true,
link: {
type: 'generated-index',
title: 'How-to guides',
@ -101,6 +102,7 @@ module.exports = {
},
{
label: 'Reference documentation',
collapsed: false,
type: 'category',
link: {
type: 'generated-index',
@ -109,35 +111,17 @@ module.exports = {
'Technical reference documentation relating to Unleash, including APIs, SDKs, Unleash concepts and deployment.',
slug: '/reference',
},
collapsible: true,
items: [
{
type: 'category',
link: {
type: 'generated-index',
title: 'Unleash concepts',
description:
'Documents describing the inner parts of Unleash.',
slug: '/reference/concepts',
},
label: 'Unleash concepts',
link: { type: 'doc', id: 'addons/index' },
items: [
'user_guide/activation_strategy',
'advanced/archived_toggles',
'advanced/audit_log',
'advanced/custom_activation_strategy',
'user_guide/environments',
'advanced/feature_toggle_types',
'advanced/toggle_variants',
'user_guide/projects',
'user_guide/rbac',
'advanced/enterprise-authentication',
'advanced/stickiness',
'advanced/strategy_constraints',
'advanced/tags',
'user_guide/technical_debt',
'user_guide/unleash_context',
'addons/datadog',
'addons/slack',
'addons/teams',
'addons/webhook',
],
label: 'Addons',
},
{
type: 'category',
@ -185,10 +169,9 @@ module.exports = {
},
{
type: 'category',
label: 'Unleash SDKs',
label: 'Client SDKs',
link: { type: 'doc', id: 'sdks/index' },
items: [
'sdks/unleash-proxy',
{
type: 'category',
label: 'Server-side SDKs',
@ -246,17 +229,6 @@ module.exports = {
'deploy/securing_unleash',
],
},
{
type: 'category',
link: { type: 'doc', id: 'addons/index' },
items: [
'addons/datadog',
'addons/slack',
'addons/teams',
'addons/webhook',
],
label: 'Addons',
},
{
type: 'category',
label: 'Integrations',
@ -271,10 +243,40 @@ module.exports = {
,
],
},
{
type: 'category',
link: {
type: 'generated-index',
title: 'Unleash concepts',
description:
'Documents describing the inner parts of Unleash.',
slug: '/reference/concepts',
},
label: 'Unleash concepts',
items: [
'user_guide/activation_strategy',
'advanced/archived_toggles',
'advanced/audit_log',
'advanced/custom_activation_strategy',
'user_guide/environments',
'advanced/feature_toggle_types',
'advanced/toggle_variants',
'user_guide/projects',
'user_guide/rbac',
'advanced/enterprise-authentication',
'advanced/stickiness',
'advanced/strategy_constraints',
'advanced/tags',
'user_guide/technical_debt',
'user_guide/unleash_context',
'sdks/unleash-proxy',
],
},
],
},
{
label: 'Topic guides',
collapsed: false,
type: 'category',
link: {
type: 'generated-index',