diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 61b7c4c38..6efa67a20 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -20,7 +20,7 @@ body: attributes: label: Have you read the Documentation Contribution Guidelines? options: - - label: I have read the [Documentation Contribution Guidelines](https://wails.io/docs/next/contributing/documenting). + - label: I have read the [Documentation Contribution Guidelines](https://wails.io/contributing/documenting). required: true - type: textarea diff --git a/website/docs/contributing/_category_.json b/website/docs/contributing/_category_.json deleted file mode 100644 index fad21931a..000000000 --- a/website/docs/contributing/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Contributing", - "position": 99 -} diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0c7af260a..592aa6c97 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -146,7 +146,7 @@ const config = { position: "right", dropdownItemsAfter: [ { - to: "/docs/contributing/documenting", + to: "/contributing/documenting", label: "Help Us Translate ❤", }, ], diff --git a/website/i18n/en/docusaurus-plugin-content-docs/current.json b/website/i18n/en/docusaurus-plugin-content-docs/current.json index 9bc66bdbd..7622763f2 100644 --- a/website/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/en/docusaurus-plugin-content-docs/current.json @@ -3,36 +3,64 @@ "message": "Next Version 🚧", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.Getting Started": { + "sidebar.docs.category.Getting Started": { "message": "Getting Started", - "description": "The label for category Getting Started in sidebar tutorialSidebar" + "description": "The label for category Getting Started in sidebar docs" }, - "sidebar.tutorialSidebar.category.Reference": { + "sidebar.docs.category.Reference": { "message": "Reference", - "description": "The label for category Reference in sidebar tutorialSidebar" + "description": "The label for category Reference in sidebar docs" }, - "sidebar.tutorialSidebar.category.Runtime": { + "sidebar.docs.category.Runtime": { "message": "Runtime", - "description": "The label for category Runtime in sidebar tutorialSidebar" + "description": "The label for category Runtime in sidebar docs" }, - "sidebar.tutorialSidebar.category.Community": { + "sidebar.docs.category.Community": { "message": "Community", - "description": "The label for category Community in sidebar tutorialSidebar" + "description": "The label for category Community in sidebar docs" }, - "sidebar.tutorialSidebar.category.Showcase": { + "sidebar.docs.category.Showcase": { "message": "Showcase", - "description": "The label for category Showcase in sidebar tutorialSidebar" + "description": "The label for category Showcase in sidebar docs" }, - "sidebar.tutorialSidebar.category.Guides": { + "sidebar.docs.category.Guides": { "message": "Guides", - "description": "The label for category Guides in sidebar tutorialSidebar" + "description": "The label for category Guides in sidebar docs" }, - "sidebar.tutorialSidebar.category.Tutorials": { + "sidebar.docs.category.Tutorials": { "message": "Tutorials", - "description": "The label for category Tutorials in sidebar tutorialSidebar" + "description": "The label for category Tutorials in sidebar docs" }, - "sidebar.tutorialSidebar.category.Contributing": { + "sidebar.docs.category.Contributing": { "message": "Contributing", - "description": "The label for category Contributing in sidebar tutorialSidebar" + "description": "The label for category Contributing in sidebar docs" + }, + "sidebar.docs.link.Ways of contributing": { + "message": "Ways of contributing", + "description": "The label for link Ways of contributing in sidebar docs, linking to /contributing/ways-of-contributing" + }, + "sidebar.docs.link.Setting up a Development Environment": { + "message": "Setting up a Development Environment", + "description": "The label for link Setting up a Development Environment in sidebar docs, linking to /contributing/setting-up-a-dev-environment" + }, + "sidebar.docs.link.Developing New Features": { + "message": "Developing New Features", + "description": "The label for link Developing New Features in sidebar docs, linking to /contributing/developing-new-features" + }, + "sidebar.docs.link.Fixing Bugs": { + "message": "Fixing Bugs", + "description": "The label for link Fixing Bugs in sidebar docs, linking to /contributing/fixing-bugs" + }, + "sidebar.docs.link.Testing": { + "message": "Testing", + "description": "The label for link Testing in sidebar docs, linking to /contributing/testing" + }, + "sidebar.docs.link.Documenting": { + "message": "Documenting", + "description": "The label for link Documenting in sidebar docs, linking to /contributing/documenting" + }, + "sidebar.docs.link.Helping Others": { + "message": "Helping Others", + "description": "The label for link Helping Others in sidebar docs, linking to /contributing/helping-others" } } diff --git a/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.39.json b/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.43.json similarity index 93% rename from website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.39.json rename to website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.43.json index 50826a275..375e7f9ef 100644 --- a/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.39.json +++ b/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.43.json @@ -1,7 +1,7 @@ { "version.label": { - "message": "v2.0.0-beta.39", - "description": "The label for version v2.0.0-beta.39" + "message": "v2.0.0-beta.43", + "description": "The label for version v2.0.0-beta.43" }, "sidebar.tutorialSidebar.category.Getting Started": { "message": "Getting Started", diff --git a/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.38.json b/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.44.json similarity index 70% rename from website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.38.json rename to website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.44.json index c195ee101..b6f38500b 100644 --- a/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.38.json +++ b/website/i18n/en/docusaurus-plugin-content-docs/version-v2.0.0-beta.44.json @@ -1,7 +1,7 @@ { "version.label": { - "message": "v2.0.0-beta.38", - "description": "The label for version v2.0.0-beta.38" + "message": "v2.0.0-beta.44", + "description": "The label for version v2.0.0-beta.44" }, "sidebar.tutorialSidebar.category.Getting Started": { "message": "Getting Started", @@ -26,5 +26,13 @@ "sidebar.tutorialSidebar.category.Guides": { "message": "Guides", "description": "The label for category Guides in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Tutorials": { + "message": "Tutorials", + "description": "The label for category Tutorials in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Contributing": { + "message": "Contributing", + "description": "The label for category Contributing in sidebar tutorialSidebar" } } diff --git a/website/sidebars.js b/website/sidebars.js index fd342f2cd..2c5450f14 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -14,7 +14,52 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + docs: [ + { type: "autogenerated", dirName: "." }, + { + type: "category", + label: "Contributing", + collapsible: true, + collapsed: false, + items: [ + { + type: "link", + label: "Ways of contributing", + href: "/contributing/ways-of-contributing", + }, + { + type: "link", + label: "Setting up a Development Environment", + href: "/contributing/setting-up-a-dev-environment", + }, + { + type: "link", + label: "Developing New Features", + href: "/contributing/developing-new-features", + }, + { + type: "link", + label: "Fixing Bugs", + href: "/contributing/fixing-bugs", + }, + { + type: "link", + label: "Testing", + href: "/contributing/testing", + }, + { + type: "link", + label: "Documenting", + href: "/contributing/documenting", + }, + { + type: "link", + label: "Helping Others", + href: "/contributing/helping-others", + }, + ], + }, + ], // But you can create a sidebar manually /* diff --git a/website/src/pages/community-guide.mdx b/website/src/pages/community-guide.mdx index 1525bed03..b4cdc09de 100644 --- a/website/src/pages/community-guide.mdx +++ b/website/src/pages/community-guide.mdx @@ -2,4 +2,4 @@ The number of Wails users is growing at an incredible rate, and if you're reading this, chances are you're ready to join. So... welcome! -To become a contributor please see the [ways of contributing](/docs/next/contributing/ways-of-contributing). +To become a contributor please see the [ways of contributing](/contributing/ways-of-contributing). diff --git a/website/docs/contributing/developing-new-features.mdx b/website/src/pages/contributing/developing-new-features.mdx similarity index 98% rename from website/docs/contributing/developing-new-features.mdx rename to website/src/pages/contributing/developing-new-features.mdx index 513da220d..03bd7db6c 100644 --- a/website/docs/contributing/developing-new-features.mdx +++ b/website/src/pages/contributing/developing-new-features.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 20 ---- - # Developing New Features We are always keen to add features to Wails and expand on what the project can do. diff --git a/website/docs/contributing/documenting.mdx b/website/src/pages/contributing/documenting.mdx similarity index 98% rename from website/docs/contributing/documenting.mdx rename to website/src/pages/contributing/documenting.mdx index a035a4b7b..d57d6d2a8 100644 --- a/website/docs/contributing/documenting.mdx +++ b/website/src/pages/contributing/documenting.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 40 ---- - # Documenting This website is also the main documentation site for the project. Sometimes this gets diff --git a/website/docs/contributing/fixing-bugs.mdx b/website/src/pages/contributing/fixing-bugs.mdx similarity index 97% rename from website/docs/contributing/fixing-bugs.mdx rename to website/src/pages/contributing/fixing-bugs.mdx index d083267c4..0b23bf1d7 100644 --- a/website/docs/contributing/fixing-bugs.mdx +++ b/website/src/pages/contributing/fixing-bugs.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 30 ---- - # Fixing Bugs The process for fixing bugs are as follows: diff --git a/website/docs/contributing/helping-others.mdx b/website/src/pages/contributing/helping-others.mdx similarity index 95% rename from website/docs/contributing/helping-others.mdx rename to website/src/pages/contributing/helping-others.mdx index 340f51a2a..5b375f1c7 100644 --- a/website/docs/contributing/helping-others.mdx +++ b/website/src/pages/contributing/helping-others.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 50 ---- - # Helping Others A great way to contribute to the project is to help others who are experiencing difficulty. diff --git a/website/docs/contributing/setting-up-a-dev-environment.mdx b/website/src/pages/contributing/setting-up-a-dev-environment.mdx similarity index 96% rename from website/docs/contributing/setting-up-a-dev-environment.mdx rename to website/src/pages/contributing/setting-up-a-dev-environment.mdx index 92cb9d738..8663f4b7d 100644 --- a/website/docs/contributing/setting-up-a-dev-environment.mdx +++ b/website/src/pages/contributing/setting-up-a-dev-environment.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 10 ---- - # Setting up a Development Environment You can set up a development environment by doing the following: diff --git a/website/docs/contributing/testing.mdx b/website/src/pages/contributing/testing.mdx similarity index 96% rename from website/docs/contributing/testing.mdx rename to website/src/pages/contributing/testing.mdx index d01204651..5d1567154 100644 --- a/website/docs/contributing/testing.mdx +++ b/website/src/pages/contributing/testing.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 35 ---- - # Testing Testing is vitally important to ensure quality in the project. There are a couple of diff --git a/website/docs/contributing/ways-of-contributing.mdx b/website/src/pages/contributing/ways-of-contributing.mdx similarity index 95% rename from website/docs/contributing/ways-of-contributing.mdx rename to website/src/pages/contributing/ways-of-contributing.mdx index a06bf8301..c66d426ce 100644 --- a/website/docs/contributing/ways-of-contributing.mdx +++ b/website/src/pages/contributing/ways-of-contributing.mdx @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # Ways of contributing Wails is an open source, community driven project. We welcome anyone to join us in