Skip to content

Commit

Permalink
Restructure navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Sep 30, 2023
1 parent 4e6968e commit 594fc3c
Show file tree
Hide file tree
Showing 10 changed files with 147 additions and 66 deletions.
15 changes: 15 additions & 0 deletions documentation/developer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: developer_documentation
title: Developer documentation
description: 'Everything HACS for publishers.'
sidebar_position: 0
---

Hi there :wave:

This is the beginning of the developer documentation.

Use the sidebar to navigate this section.

- [If you are looking for how to use HACS have a look at the user documentation](/docs/user)
- [If you are looking for how to publish something that can be tracked by HACS have a look at the publisher documentation](/docs/publisher)
3 changes: 1 addition & 2 deletions documentation/developer/start.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
id: start
title: Getting started
description: "Getting started with HACS development"
sidebar_position: 0
description: 'Getting started with HACS development'
---

This integration is **massive** and there are a lot of areas to contribute to.
Expand Down
6 changes: 0 additions & 6 deletions documentation/faq/index.md

This file was deleted.

13 changes: 13 additions & 0 deletions documentation/faq/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: faq_entry
title: Frequently Asked Questions
description: "Everything might not be frequently asked, but it's a good dumping ground for various information."
sidebar_position: 0
---

import DocCardList from '@theme/DocCardList'
import { useCurrentSidebarCategory } from '@docusaurus/theme-common'

<i>{frontMatter.description}</i>

<DocCardList items={useCurrentSidebarCategory().items} />
15 changes: 15 additions & 0 deletions documentation/publisher/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: publisher_documentation
title: Publisher documentation
description: 'Everything HACS for publishers.'
sidebar_position: 0
---

Hi there :wave:

This is the beginning of the publisher documentation.

Use the sidebar to navigate this section.

- [If you are looking for how to use HACS have a look at the user documentation](/docs/user)
- [If you are looking for how to develop/change something for HACS itself have a look at the developer documentation](/docs/developer)
3 changes: 2 additions & 1 deletion documentation/setup/prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
id: prerequisites
title: Prerequisites
description: "Prerequisites"
description: 'Prerequisites'
sidebar_position: 0
---

## Requirements
Expand Down
15 changes: 15 additions & 0 deletions documentation/user/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: user_documentation
title: User documentation
description: 'Everything HACS for users.'
sidebar_position: 0
---

Hi there :wave:

This is the beginning of the user documentation.

Use the sidebar to navigate this section.

- [If you are looking for how to publish something that can be tracked by HACS have a look at the publisher documentation](/docs/publisher)
- [If you are looking for how to develop/change something for HACS itself have a look at the developer documentation](/docs/developer)
14 changes: 6 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ module.exports = {
navbar: {
title: 'HACS',
items: [
{ to: 'docs/setup/prerequisites', label: 'Download', position: 'left' },
{ to: 'docs/configuration/basic', label: 'Configuration', position: 'left' },
{ to: 'docs/basic/getting_started', label: 'Usage', position: 'left' },
{ to: 'docs/community_guides', label: 'Guides', position: 'left' },
{ to: 'docs/developer/start', label: 'Developer docs', position: 'right' },
{ to: 'docs/faq/', label: 'FAQ', position: 'right' },
{ to: 'help', label: 'Help', position: 'right' },
{ to: 'docs/user', label: 'Use', position: 'left' },
{ to: 'docs/publisher', label: 'Publish', position: 'left' },
{ to: 'docs/faq/', label: 'FAQ', position: 'left' },
{ to: 'help', label: 'Help', position: 'left' },
{ to: 'docs/developer', label: 'Develop', position: 'right' },
],
},
footer: {
Expand Down Expand Up @@ -98,7 +96,7 @@ module.exports = {
{
redirects: [
{
from: ["/default_repositories"],
from: ["/default_repositories",],
to: "/"
},
{
Expand Down
125 changes: 78 additions & 47 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -1,56 +1,87 @@
module.exports = {
usage: {
Basic: [
"user": {
"User documentation": [
{
type: 'autogenerated',
dirName: 'basic',
}
],
Navigation: [{
type: 'autogenerated',
dirName: 'navigation',
}],
Entities: [
{
type: 'autogenerated',
dirName: 'entities',
}
],
Categories: [
"type": "autogenerated",
"dirName": "user"
},
{
type: 'autogenerated',
dirName: 'categories',
}
],
"Download": [
{
"type": "autogenerated",
"dirName": "setup"
}
]
},
{
"Configuration": [
{
"type": "autogenerated",
"dirName": "configuration"
}
]
},
{
"Categories": [
{
"type": "autogenerated",
"dirName": "categories"
}
]
},
{
"Usage": [
{
"type": "autogenerated",
"dirName": "basic"
}
]
},
{
"Entities": [
{
"type": "autogenerated",
"dirName": "entities"
}
]
},
{
"Navigation": [
{
"type": "autogenerated",
"dirName": "navigation"
}
]
},
"community_guides"
]
},
setup: {
Setup: ['setup/prerequisites', 'setup/download'],
Configuration: ['configuration/basic', 'configuration/options'],
Remove: ['setup/remove'],
"publisher": {
"Publisher documentation": [
{
"type": "autogenerated",
"dirName": "publisher"
},
{
"type": "autogenerated",
"dirName": "publish"
}
]
},
'developer documentation': {
'HACS Development': [
"developer": {
"Developer documentation": [
{
type: 'autogenerated',
dirName: 'developer',
"type": "autogenerated",
"dirName": "developer"
}
],
'Publish to HACS': [
'publish/start',
'publish/appdaemon',
'publish/integration',
'publish/plugin',
'publish/python_script',
'publish/theme',
'publish/include',
'publish/action',
'publish/remove',
],
]
},
FAQ: [
"faq": {
"FAQ": [
{
type: 'autogenerated',
dirName: 'faq',
},
],
}
"type": "autogenerated",
"dirName": "faq"
}
]
}
}
4 changes: 2 additions & 2 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ function Home() {
'button button--outline button--secondary button--lg btt',
styles.indexButton,
)}
to={useBaseUrl('docs/basic/getting_started')}
to={useBaseUrl('docs/publisher')}
>
USE
PUBLISH
</Link>
</div>
</div>
Expand Down

0 comments on commit 594fc3c

Please sign in to comment.