5
0
mirror of https://github.com/wailsapp/wails.git synced 2025-05-02 10:39:50 +08:00

feat(website): change contribution guide type from "doc" to "page" (#1777)

This commit is contained in:
Misite Bao 2022-08-23 18:52:56 +08:00 committed by GitHub
parent 7da8b28d0b
commit 250c97e6a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 105 additions and 56 deletions

View File

@ -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

View File

@ -1,4 +0,0 @@
{
"label": "Contributing",
"position": 99
}

View File

@ -146,7 +146,7 @@ const config = {
position: "right",
dropdownItemsAfter: [
{
to: "/docs/contributing/documenting",
to: "/contributing/documenting",
label: "Help Us Translate ❤",
},
],

View File

@ -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"
}
}

View File

@ -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",

View File

@ -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"
}
}

View File

@ -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
/*

View File

@ -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).

View File

@ -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.

View File

@ -1,7 +1,3 @@
---
sidebar_position: 40
---
# Documenting
This website is also the main documentation site for the project. Sometimes this gets

View File

@ -1,7 +1,3 @@
---
sidebar_position: 30
---
# Fixing Bugs
The process for fixing bugs are as follows:

View File

@ -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.

View File

@ -1,7 +1,3 @@
---
sidebar_position: 10
---
# Setting up a Development Environment
You can set up a development environment by doing the following:

View File

@ -1,7 +1,3 @@
---
sidebar_position: 35
---
# Testing
Testing is vitally important to ensure quality in the project. There are a couple of

View File

@ -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