Contribution

How to contribute to zudo-doc, and the project's background and maintenance approach.

Background

zudo-doc was created as a documentation framework by Takazudo. It was originally built for personal use — a lightweight alternative to Docusaurus, tailored to the specific workflow and design preferences that kept coming up across multiple projects.

Over time, it grew into a standalone framework with features like a themeable ramp-based color system, MDX content collections, i18n support, and Claude Code integration.

Development

Most of the source code in this project was written with the help of Claude Code. The framework is openly available under the MIT License.

Maintenance

This project is maintained on a best-effort basis. Active maintenance and thorough review of contributions may be limited.

Rather than waiting for official support, you are encouraged to fork the repository and implement your own modifications as needed. In the AI era, forking and customizing is often faster than waiting for upstream changes.

How to Contribute

If you'd like to contribute:

1. Fork the repository on GitHub

2. Create a topic branch from main

3. Make your changes and ensure pnpm b4push passes (scripts/run-b4push.sh is authoritative for the current step list — E2E runs in CI, not in b4push, for time-budget reasons)

4. Open a pull request with a clear description of what you changed and why

Bug reports and feature requests are welcome as GitHub Issues.

License

zudo-doc is released under the MIT License.

Author

• Takeshi Takatsudo (@Takazudo)