k230 sdk docs release v0.8

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# 贡献指南
+
+首先感谢您参与本开源项目，在您提交issue和pull request之前请认真阅读本指南
+
+在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue  
+关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考[Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
+
+issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考[GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github)
+
+## 提交issue
+
+1. 打开issue界面 [isuue](https://github.com/kendryte/k230_docs/issues)
+2. 查看issue列表中是否已经存在相似issue，如果没有请点击`New issue`按钮
+3. 根据您的问题类型，选择不同的issue模板
+4. 填写必须项后(带红色\*标记)，点击`Submit new issue`按钮完成提交
+
+## 提交pull request
+
+1. Fork本仓库到您的github
+2. Clone仓库到您本地
+3. 您可以基于`main`分支创建新分支并添加更改`git checkout -b newbranch -l main`
+4. 提交您的更改到您的github
+5. 进入您的github仓库点击`Pull request`按钮后点击`New pull request`按钮
+6. 选择`base repository`为`kendryte/k230_docs`，选择`base`为`main`，选择`head repository`为`yourname/k230_docs`，选择`compare`为`newbranch`
+7. 根据pull request模板要求填写您的描述
+8. 点击`Create pull request`完成提交
+
+> 如果您对以上流程还有不清楚的地方请参考[GitHub PR Flow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
+
+## Markdown检查
+
+本项目会对上传的Markdown文件进行格式化检查和内部引用链接检查，如果不符合格式要求或存在不能访问的链接，导致PR不能被merge，因此提交PR前请确保您已在本地进行过检查  
+格式检查工具使用的是`markdownlint`，规则配置文件是[markdownlint.json](../.markdownlint.json)。本地可使用`vscode`安装`markdownlint`来进行在线检查和格式化  
+您也可以在提交PR之前，先push到您GitHub仓库的`check`分支进行CI检查，避免重复修改PR

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: kendryte Community
+    about: kendryte 开发者社区
+    url: https://developer.canaan-creative.com/

.github/ISSUE_TEMPLATE/errata.yml

@@ -0,0 +1,15 @@
+name: Errata
+description: 向我们反馈错误
+title: "[Errata]: "
+labels: ["errata"]
+body:
+  - type: textarea
+    id: errata
+    attributes:
+      label: Errata
+      description: 勘误
+      placeholder: |
+        Please describe the wrong document and location. (请您描述一下错误的文档及位置)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/improvement.yml

@@ -0,0 +1,15 @@
+name: Improvement
+description: 向我们提出改进
+title: "[Improvement]: "
+labels: ["improvement"]
+body:
+  - type: textarea
+    id: improvement
+    attributes:
+      label: Improvement
+      description: 改进
+      placeholder: |
+        You can suggest to us to add some content or modify the typography. (您可以向我们建议新增某些内容或修改排版)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,15 @@
+name: Other
+description: 其它问题
+title: "[other]: "
+labels: []
+body:
+  - type: textarea
+    id: other
+    attributes:
+      label: Other
+      description: 其它问题
+      placeholder: |
+        If you have any other questions you can describe them here. (如果您有任何其它问题可以在这里描述)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: true

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+<!--
+请按照以下要求填写此PR模板
+1. 根据此PR的类型在右侧'Labels'位置添加对应的label。比如此PR修复了某个错误，则添加'errata'label；此PR新增了某些内容，则添加'improvement'label。
+2. 在'PR描述'项里填写此PR解决了什么问题，比如修复了某个错误或新增了某些内容。
+3. 在'关联issue'项里填写相关issue号(输入'#'会自动提示issue)，推荐使用'close'、'fix'、'resolve'等关键字进行自动关联(如'fix #1')，也可以提交PR后在右侧'Development'中进行手动关联。
+4. 确定上传的markdown文件已经过格式化检查。
+-->
+
+## PR描述:
+
+
+## 关联issue:
+
+<!-- 请同时更新中文和英文文档。 -->

.gitignore

@@ -0,0 +1,3 @@
+*.pdf
+.DS_Store
+**/.DS_Store

.gitlab-ci.yml

@@ -0,0 +1,24 @@
+# docker image from https://github.com/DavidAnson/markdownlint-cli2
+# vscode markdownlint https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
+# markdownlint-cli2: https://github.com/DavidAnson/markdownlint-cli2
+# markdownlint rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+#
+
+markdownlint:
+  rules:
+    # MR job
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "dev"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"
+    # release job
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_TAG =~ /^v\d+\.\d+.*$/
+    # pre-release job
+    - if: '$CI_PIPELINE_SOURCE == "web"'
+      when: always
+  stage: test
+  timeout: 10m
+  image: registry.gitlab.com/pipeline-components/markdownlint-cli2:latest
+  tags: 
+    - k230
+  script:
+   - markdownlint-cli2 *.md **/*.md **/**/*.md **/**/**/*.md **/**/**/**/*.md
+

.gitlab/merge_request_templates/doc.md

@@ -0,0 +1,11 @@
+# Merge Request
+<!--请按要求填写Merge Request模板，详细说明新增内容, 支持Markdown语法和格式-->
+
+## 1. Doc概述
+<!--请在此注释之后添加当前Merge Request新增或修改Doc的简要描述-->
+
+## 2. 详细说明
+<!--请在此注释之后描述当前Merge Request新增或修改Doc的详细说明，例如增加或修改了什么功能的文档内容等修改详情-->
+
+## 3. JIRA BUG Link
+<!--请提供JIRA BUG链接，如没有可不填-->

.markdownlint.json

@@ -0,0 +1,104 @@
+{
+    // MD003
+    "heading-style": {
+        "style": "atx"
+    },
+    // MD004
+    "ul-style": {
+        "style": "consistent"
+    },
+    // MD007
+    "ul-indent": {
+        "indent": 2
+    },
+    // MD009
+    "no-trailing-spaces": {
+        "br_spaces": 2,
+        "list_item_empty_lines": false,
+        "strict": false
+    },
+    // MD010
+    "no-hard-tabs": {
+        "code_blocks": true,
+        "ignore_code_languages": ["Makefile","makefile"],
+        "spaces_per_tab": 1
+    },
+    // MD011
+    "no-multiple-blanks": {
+        "maximum": 1
+    },
+    // MD013
+    "line-length": {
+        "strict": false,
+        "line_length": 2000,
+        "code_blocks": false
+    },
+    // MD022
+    "blanks-around-headers": {
+        "lines_above": 1,
+        "lines_below": 1
+    },
+    // MD025
+    "single-title": {
+        "level": 1
+    },
+    // MD024
+    "no-duplicate-heading": {
+        "allow_different_nesting": false,
+        "siblings_only": false
+    },
+    // MD029
+    "ol-prefix": {
+        //"style": "one_or_ordered"
+        "style": "one"
+    },
+    // MD030
+    "list-marker-space": {
+        "ol_multi": 1,
+        "ol_single": 1,
+        "ul_multi": 1,
+        "ul_single": 1
+    },
+    // MD031
+    "blanks-around-fences": {
+        "list_items": true
+    },
+    // MD033
+    "no-inline-html": {
+        "allowed_elements": ["div"]
+    },
+    // MD035
+    "hr-style": {
+        "style": "---"
+    },
+    // MD040
+    "fenced-code-language": {
+        "allowed_languages": [],
+        "language_only": false
+    },
+    // MD041
+    "first-line-heading": {
+        "level": 1
+    },
+    // MD044
+    "proper-names": {
+        "code_blocks": true,
+        "names": []
+    },
+    // MD046
+    "code-block-style": {
+        "style": "fenced"
+    },
+    // MD048
+    "code-fence-style": {
+        "style": "backtick"
+    },
+    // MD049
+    "emphasis-style": {
+        "style": "asterisk"
+    },
+    // MD050
+    "strong-style": {
+        "style": "asterisk"
+    }
+}