Documentation Steps - WSU-CptS-581-2025/zerocode GitHub Wiki
Documentation - How to fix or add new content to the Documentation?
Documentation Template To Use
Use this template when you are adding a new documentation page or amending an existing page.
Use this Documentation Template: here
Steps Below
Create a new branch(or fork)from the "main" from the below repo:
- Then navigate to respective folder under "pages" folder e.g.
- For "microservices" related content: https://github.com/authorjapps/zerocode-tdd-docs/tree/main/pages/microservices
- For "kafka" related content: https://github.com/authorjapps/zerocode-tdd-docs/tree/main/pages/kafka
- so on... depending on the content you are trying to add/modify
- Add a new Page or modify the existing content as required
- If you are adding any new page(s), then add a ".MDX" file under the relevant folder(or ask if in doubt)
- Note ".MD" file also works
Folders
List:
======
assertions
blogs
cicd
collaboration
database
extensions
faqs
kafka
load
microservices
security
Step 1:
- First, add/amend the required content and then raise a PR and get it approved
Step 2:
- If needed, Do the changes to more pages/contents and raise another PR
Step 3:
- If more content is to be added/fixed, then raise more smaller PRs(instead of a large PR), which makes it easy to review and merge