Introduction¶

Overview¶

Documentation is a hard part and not-much effort from the team.

Principle: Short, Introductive.

The documentation focus to focus content for targeted audiances to understading the content

Our service mostly use the markdown to share the content inside the team.

Component¶

Markdown syntax¶

For math syntax: using Katex or Math https://katex.org/docs/supported.html

Write PR

For developers/maintainers/..., please contributes with more details elements.

E.g: Idea - Short introduction about your ideas - Label [Feature/Issues/Enhance] - ref URL.

Multiple Toc¶

<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=2 orderedList=false} -->

<!-- code_chunk_output -->

- [Notification: CloudBuild Execution Status](#notification-cloudbuild-execution-status)
  - [**Overview**](#overview)
  - [**SAD**](#sad)
  - [**Reference**](#source-reference)

<!-- /code_chunk_output -->

Create Issue for Tracking¶

Create issue in GitHub

https://python101.pythonlibrary.org/chapter21_thread.html

https://docs.python.org/3/library/tempfile.html

• For mkdocs configuration, following Configuration documentation

• For material configuration, following material official documentation

Tool¶

• Document: Markdown for text content

• Diagram content: mermiad for SAD, context boundary component

• Icon: control from FontAwesome

• Lint: using extension IDE of markdownlint to adopt Markdown standard

Reference¶

• mkdocs Official Documentation