[release]

This commit is contained in:
junhuanchen
2022-07-06 11:24:18 +08:00
parent 617071829d
commit e75d983e11
2979 changed files with 179509 additions and 1570 deletions

48
share_docs/en/add_doc.md Normal file
View File

@@ -0,0 +1,48 @@
# Share article
## Prepare
- This site is built by teedoc, so we need to install it first.
### About teedoc
If you have trouble using this site, pleasr refer to https://teedoc.github.io/en/
### build locally
* Install teedoc
```
pip3 install teedoc --upgrade
```
* Get site source files
```
git clone https://github.com/sipeed/sipeed_wiki.git
```
* Install related plugins
```
cd sipeed_wiki
teedoc install
```
* build and serve locally
```
teedoc serve
```
then visit [http://127.0.0.1:2333](http://127.0.0.1:2333) to see your local site
## Add article
Normally all docs are put in the folder named docs which is in the root path.
When finishing writing the document you want to share under the appropriate corresponding directory, edit the file with name **sidebar** to make your file to be shown in the corresponding place on the web page.
Then you can then view the effect in the locally built site.
If you think you have finish this job, just create pull request and we'll merge it .

View File

@@ -0,0 +1,19 @@
# Edit document
Because too many documents are in this site, editors may not notice errors or bugs in documents.
So if you find something wrong or incorrect, you can edit this page.
1. Go to the target site
2. Click Edit this page
![](./../assets/1.png)
3. Sign in github
![](./../assets/2.png)
4. Click the edit icon on text box to change the content of article.
![](./../assets/3.png)
The content may show as below, just correct what you think need to be changed.
![](./../assets/4.png)
5. Pull requset after your finishing editing and add the reason why change it.
![](./../assets/5.png)
We will merge request if ok.

View File

@@ -0,0 +1,4 @@
{
"import": "config_en",
"name": "Edit Wiki"
}

11
share_docs/en/readme.md Normal file
View File

@@ -0,0 +1,11 @@
# Edit wiki
Sometimes editor may not notice some errors, or you have some article and want to share with people.
Both situations are need editing wiki.
Here are two ways to edit wiki.
- [**Edit document**](./change_doc.md) <--Click it
- [**Share document**](./add_doc.md) <--Click it

View File

@@ -0,0 +1,16 @@
{
"items": [
{
"label": "Readme",
"file" : "./readme.md"
},
{
"label": "Edit content",
"file" : "./change_doc.md"
},
{
"label": "Add document",
"file" : "./add_doc.md"
}
]
}