Call for Documentation Errors
TechUI is a high-speed iterative project. Due to the rapid pace of the "One Person + AI" development model, the speed of documentation writing sometimes has to compromise with the speed of code iteration.
Frankly speaking, the current documentation construction has been somewhat rushed, resulting in many omissions and gaps. We need your sharp eyes to help us fill these missing pieces.
Known Imperfections
During use, you may encounter the following missing documentation; these are not missing features, but rather instances where the documentation has not yet caught up:
CSS Variable Definitions
- Current Status: Most TechUI components have a rich set of CSS Variables reserved in their underlying design for style customization. However, in the current document API lists, these variables might not be listed individually.
- Explanation: If you find that styles cannot be modified via Props, it can usually be achieved by overriding CSS Variables. If you discover a CSS Var not mentioned in the documentation, we welcome you to submit it to us for supplementation.
Missing Demos
- Current Status: Some new components may only have basic code snippets and lack intuitive interactive demos.
Incomplete Test Cases
- Current Status: For the sake of rapid delivery, unit test code in some component documentation may be overly simplified or not yet uploaded.
How to Submit Feedback?
If you find errors in the documentation during use (typos, broken links, incorrect parameter descriptions) or discover any of the "missing documentation" sections mentioned above, please let us know.
You can participate in co-building the documentation through the following methods:
- Submit an Issue: Use the
[Doc]tag for feedback in GitHub Issues. - Direct PR: If you know how to fix it, submitting a Pull Request directly is the most welcomed method.
- Supplement CSS Var: If you uncover useful hidden CSS variables in the source code, please tell us; we will update the documentation to benefit more developers.
Documentation as a Product
We are well aware that good documentation is just as important as high-quality code. Thank you for your tolerance of the "semi-finished" state of TechUI's documentation; every piece of your feedback is making this manual thicker and more accurate.
Contact Us
To report documentation errors, please contact TechUI through the following methods:
Community
