Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs - nested sidebar #1230

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
211 changes: 101 additions & 110 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
@@ -1,115 +1,106 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation

The sidebars can be generated from the filesystem, or explicitly defined here.

Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
sidebarBoltPy: [
{
type: 'doc',
id: 'index',
label: 'Bolt for Python',
className: 'sidebar-title',
},
'getting-started',
{
type: 'category',
label: 'Basic concepts',
items: [
'basic/assistant',
'basic/message-listening',
'basic/message-sending',
'basic/event-listening',
'basic/web-api',
'basic/action-listening',
'basic/action-respond',
'basic/acknowledge',
'basic/shortcuts',
'basic/commands',
'basic/opening-modals',
'basic/updating-pushing-views',
'basic/view_submissions',
'basic/app-home',
'basic/options',
'basic/custom-steps',
'basic/authenticating-oauth',
'basic/socket-mode'
],
},
{
type: 'category',
label: 'Advanced concepts',
items: [
'advanced/adapters',
'advanced/custom-adapters',
'advanced/async',
'advanced/errors',
'advanced/logging',
'advanced/authorization',
'advanced/token-rotation',
'advanced/listener-middleware',
'advanced/global-middleware',
'advanced/context',
'advanced/lazy-listeners',
],
},
{
type: 'category',
label: 'Steps from apps (Deprecated)',
items: [
'steps/steps',
'steps/executing-steps',
'steps/creating-steps',
'steps/adding-editing-steps',
'steps/saving-steps',
],
},
{ type: 'html', value: '<hr>' },
{
type: 'category',
label: 'Tutorials',
items: [
'tutorial/getting-started-http',
'tutorial/ai-chatbot',
`tutorial/custom-steps-for-jira`
],
},
{ type: 'html', value: '<hr>' },
{
type: 'link',
label: 'Reference',
href: 'https://tools.slack.dev/bolt-python/api-docs/slack_bolt/',
},
{ type: 'html', value: '<hr>' },
{
type: 'link',
label: 'Release notes',
href: 'https://github.com/slackapi/bolt-python/releases',
},
{
type: 'link',
label: 'Code on GitHub',
href: 'https://github.com/SlackAPI/bolt-python',
},
{
type: 'link',
label: 'Contributors Guide',
href: 'https://github.com/SlackAPI/bolt-python/blob/main/.github/contributing.md',
},
],
sidebarBoltPy: [
{
type: "doc",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm assuming this is from the python repo formatting -- 4 spaces is python standard i believe

id: "index",
label: "Bolt for Python",
className: "sidebar-title",
},
{ type: "html", value: "<hr>" },
{
type: "category",
label: "Guides",
collapsed: false,
items: [
Comment on lines +10 to +14
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is all i added

"getting-started",
{
type: "category",
label: "Basic concepts",
items: [
"basic/assistant",
"basic/message-listening",
"basic/message-sending",
"basic/event-listening",
"basic/web-api",
"basic/action-listening",
"basic/action-respond",
"basic/acknowledge",
"basic/shortcuts",
"basic/commands",
"basic/opening-modals",
"basic/updating-pushing-views",
"basic/view_submissions",
"basic/app-home",
"basic/options",
"basic/custom-steps",
"basic/authenticating-oauth",
"basic/socket-mode",
],
},
{
type: "category",
label: "Advanced concepts",
items: [
"advanced/adapters",
"advanced/custom-adapters",
"advanced/async",
"advanced/errors",
"advanced/logging",
"advanced/authorization",
"advanced/token-rotation",
"advanced/listener-middleware",
"advanced/global-middleware",
"advanced/context",
"advanced/lazy-listeners",
],
},
{
type: "category",
label: "Steps from apps (Deprecated)",
items: [
"steps/steps",
"steps/executing-steps",
"steps/creating-steps",
"steps/adding-editing-steps",
"steps/saving-steps",
],
},
],
},
{ type: "html", value: "<hr>" },
{
type: "category",
label: "Tutorials",
items: [
"tutorial/getting-started-http",
"tutorial/ai-chatbot",
"tutorial/custom-steps-for-jira",
],
},
{ type: "html", value: "<hr>" },
{
type: "link",
label: "Reference",
href: "https://tools.slack.dev/bolt-python/api-docs/slack_bolt/",
},
{ type: "html", value: "<hr>" },
{
type: "link",
label: "Release notes",
href: "https://github.com/slackapi/bolt-python/releases",
},
{
type: "link",
label: "Code on GitHub",
href: "https://github.com/SlackAPI/bolt-python",
},
{
type: "link",
label: "Contributors Guide",
href: "https://github.com/SlackAPI/bolt-python/blob/main/.github/contributing.md",
},
],
};

export default sidebars;
Loading