Hello everyone! 👋 Welcome to the Kombase documentation repository — a magical place where all our UI components are documented so our lives as developers can be a little more peaceful and drama-free. 🧘♂️✨
Kombase is an awesome monorepo that contains:
@kombase(Component Workspace): Our go-to UI component library built with love, sweat, and sleepless nights.docs(Documentation): The interactive documentation site you're reading right now.
This isn't just any ordinary documentation. We built it with an advanced system so you'll want to stay and read the docs all day! 💅
When you're done showing off, I mean done with development, it's time to build:
# From the monorepo root
pnpm build:docs
# Or directly in the docs folder
pnpm buildThis project has high discipline! We use Husky, Commitlint, and Changesets to automate our changelogs. Make sure your commit messages follow the Conventional Commits standard.
Good examples ✅:
feat: add DataTable documentationfix: resolve hydration error on the component pagedocs: update readme to make it funny
Strictly forbidden examples ❌:
fix bugupdate againasdfghjkl
Don't write sloppy commit messages. The automated system will reject them and you'll have to write them all over again! 🤖
If you find a bug, a messed-up layout, or have a brilliant idea, don't hesitate to open an issue or go straight for a Pull Request. We gladly accept contributions, whether it's code, design, or just fixing a silly typo.
Built with ❤️, lots of water, and prayers by the Kombase team.