From b421e1070a740ed2c30b35c571cbb1d900ae5b62 Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Thu, 20 Feb 2025 10:48:54 +0100 Subject: [PATCH] Prepare dev docs for automation --- docs/dev/intro.md | 5 ++ docusaurus.config.ts | 6 ++ i18n/de/code.json | 4 + i18n/de/docusaurus-theme-classic/navbar.json | 4 + i18n/en/code.json | 4 + sidebars.ts | 1 + src/pages/index.tsx | 85 +++++++++++--------- 7 files changed, 73 insertions(+), 36 deletions(-) create mode 100644 docs/dev/intro.md diff --git a/docs/dev/intro.md b/docs/dev/intro.md new file mode 100644 index 00000000..df23cd51 --- /dev/null +++ b/docs/dev/intro.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 1 +--- + +# Welcome to dev docs diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ff152656..0ba53b4b 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -77,6 +77,12 @@ const config: Config = { position: 'left', label: 'Admin', }, + { + type: 'docSidebar', + sidebarId: 'dev', + position: 'left', + label: 'Dev', + }, { type: 'localeDropdown', position: 'right' diff --git a/i18n/de/code.json b/i18n/de/code.json index 62379fea..43a7c5e4 100644 --- a/i18n/de/code.json +++ b/i18n/de/code.json @@ -352,5 +352,9 @@ "theme.SearchBar.label": { "message": "Suche", "description": "The ARIA label and placeholder for search button" + }, + "homepage.link.item.label.Developer Documentation": { + "message": "Developer Dokumentation", + "description": "The label for the link to developer documentation" } } diff --git a/i18n/de/docusaurus-theme-classic/navbar.json b/i18n/de/docusaurus-theme-classic/navbar.json index 69b1b0a8..93221b47 100644 --- a/i18n/de/docusaurus-theme-classic/navbar.json +++ b/i18n/de/docusaurus-theme-classic/navbar.json @@ -10,5 +10,9 @@ "item.label.Admin": { "message": "Admin", "description": "Navbar item with label Admin" + }, + "item.label.Developer": { + "message": "Developer", + "description": "Navbar item with label Developer" } } diff --git a/i18n/en/code.json b/i18n/en/code.json index 9bd72e06..48c424dd 100644 --- a/i18n/en/code.json +++ b/i18n/en/code.json @@ -352,5 +352,9 @@ "theme.SearchPage.noResultsText": { "message": "No documents were found", "description": "The paragraph for empty search result" + }, + "homepage.link.item.label.Developer Documentation": { + "message": "Developer Documentation", + "description": "The label for the link to developer documentation" } } diff --git a/sidebars.ts b/sidebars.ts index 81f8f60c..c0260d84 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -17,6 +17,7 @@ const sidebars: SidebarsConfig = { tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], admin: [{type: 'autogenerated', dirName: 'admin'}], user: [{type: 'autogenerated', dirName: 'user'}], + dev: [{type: 'autogenerated', dirName: 'dev'}], // But you can create a sidebar manually /* diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 08d262da..e84fe0d5 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -12,45 +12,58 @@ function HomepageHeader() { const {siteConfig} = useDocusaurusContext(); return (
-
- - {siteConfig.title} - -

{siteConfig.tagline}

-



- - - User Documentation - - -

-
- - - Admin Documentation - - -

-
+
+ + {siteConfig.title} + +

{siteConfig.tagline}

+



+ + + User Documentation + + +
+
+
+ + + Admin Documentation + + +
+
+
+ + + Developer Documentation + + +
+
); } export default function Home(): ReactNode { - return ( - - -
-
-
- ); + return ( + + +
+
+
+ ); }