This is an automated email from the ASF dual-hosted git repository.
robin0716 pushed a commit to branch docs/plugin
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
The following commit(s) were added to refs/heads/docs/plugin by this push:
new b7f3a2ab docs: Update plugin related documentation
b7f3a2ab is described below
commit b7f3a2ab3f2976fedbc3ab7c7233d1ae9a92bd1e
Author: robin <[email protected]>
AuthorDate: Tue Jul 2 15:21:01 2024 +0800
docs: Update plugin related documentation
---
docs/development/{overview.md => guide.md} | 4 +++-
docs/development/plugins/{overview.md => plugin.md} | 4 +++-
sidebars.js | 10 ++++++++--
3 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/docs/development/overview.md b/docs/development/guide.md
similarity index 97%
rename from docs/development/overview.md
rename to docs/development/guide.md
index 7486483d..78f61b16 100644
--- a/docs/development/overview.md
+++ b/docs/development/guide.md
@@ -1,13 +1,15 @@
---
slug: /development
---
+# Development Guide
-# Overview
+This guide will help you get started with the development of the project.
## Frontend
### Installation
+
1. Ensure you have [node](https://nodejs.org/en) and
[pnpm](https://pnpm.io/installation) installed.
2. After cloning the repository, run the following command. This will install
all dependencies as well as build all local packages.
diff --git a/docs/development/plugins/overview.md
b/docs/development/plugins/plugin.md
similarity index 98%
rename from docs/development/plugins/overview.md
rename to docs/development/plugins/plugin.md
index ce62199d..b31eff1e 100644
--- a/docs/development/plugins/overview.md
+++ b/docs/development/plugins/plugin.md
@@ -3,7 +3,9 @@
slug: /development/plugins
---
-# Overview
+# Plugins Development Guide
+
+Plugins are a way to extend the functionality of the Answer project. You can
create your own plugins to meet your own needs.
:::tip
diff --git a/sidebars.js b/sidebars.js
index fb61a46e..ebfcb3f8 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -66,14 +66,20 @@ module.exports = {
type: 'category',
label: 'Developer Guides',
collapsed: true,
+ link: {
+ type: 'doc',
+ id: 'development/guide',
+ },
items: [
- 'development/overview',
{
type: 'category',
label: 'Plugins',
collapsed: true,
+ link: {
+ type: 'doc',
+ id: 'development/plugins/plugin',
+ },
items: [
- 'development/plugins/overview',
'development/plugins/plugin-config',
'development/plugins/plugin-translation',
],
