Skip to content

Commit 14d1b70

Browse files
committed
explain AI addition
1 parent 333203a commit 14d1b70

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ Custom Command Documentation
33

44
# How to contribute?
55
You can contribute by forking this repo, [click here](https://github.com/raspdevpy/ccdoc/fork), modify the changes, then Pull request.
6+
* Some .md files ends with _ai.md, which means the file was generated with AI using the original file content, for example AI used user.md to generate user_ai.md. You can modify these files directly if it contain wrong generated information compared to the orginal file. you can modify the original, if the original file contain wrong information or missing one, after merge we will make AI regenerate the file with _ai.md with the new file.
7+
* The docs, will show _ai.md files if it exists instead of the original one, otherwise it will use the original one.
68

79
# How to run?
810
Required: Node 18.x, npm
911

1012
1. run `git clone https://github.com/raspdevpy/ccdoc`
1113
2. run `npm install`
1214
3. run `npm run dev`, and head to `https://localhost:8080`
15+

0 commit comments

Comments
 (0)