Contribution Guide
Learn how to contribute to the TaiChi112 Knowledge Base via GitHub Pull Requests.
Contribution Guide
TaiChi112 is built on the philosophy of collaborative knowledge. Every page on this platform can be modified by the community. Whether you want to Create, Read, Update, or Delete (CRUD) content, your contributions are welcome!
🤝 How to Contribute
We use a standard GitHub Pull Request workflow for all content updates.
- Find a Page: If you are reading a page and spot a typo, or have valuable information to add, click the Edit on GitHub button typically found in the page header.
- Fork and Edit: This will take you to GitHub where you can fork the repository and make your changes directly using standard Markdown / MDX syntax.
- Submit a PR: Once you are satisfied with your edits, submit a Pull Request.
- Review: The maintainers will review your PR, suggest any necessary changes, and merge it into the main knowledge base!
Content Standards
To maintain a high level of quality, please adhere to the following guidelines:
- Strict MDX: Use standard GitHub Flavored Markdown. For complex layouts, use the provided Fumadocs UI components.
- Clarity: Keep explanations clear, concise, and academic where appropriate.
- Single Source of Truth (SSOT): Ensure that if you update a concept that is referenced elsewhere, you also propose updates to the linked documents.
- Validation: Always verify your changes locally before submitting a PR.
[!TIP] If you are unsure about a major architectural addition to the documentation, feel free to open a GitHub Issue to discuss it before writing the content.