Rollkit Documentation Site

Welcome to the official documentation repository for Rollkit.

Here you'll find comprehensive guides, tutorials, and reference materials to help you make the most out of Rollkit.

Building the site

To get started, clone the repository and run the following:

yarn run docs:dev

This documentation site is built with VitePress

Contribution Guidelines

We love contributions from the community! Whether you're fixing typos, improving content clarity, or adding new topics, every contribution helps.

• Fork & Clone: Fork this repository and clone it to your local machine.
• Branch: Always create a new branch for your changes. Naming it relevantly.
• Commit Changes: Make your changes and commit them with a clear and concise commit message.
• Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.

Please ensure to review the detailed Contribution Guidelines above before making a pull request.

Directory Structure

• /tutorials: Step-by-step instructions to help users build their own rollups with Rollkit.
• /learn: Technical reference materials, such as configuration options and details about the Rollkit stack.
• /blog: Blog posts for the Rollkit blog.
• /public: Images, diagrams, and other media files used in the documentation.

Feedback & Suggestions

We value feedback from the community. If you have suggestions for improvements or find any discrepancies in the documentation, please raise an issue in this repository.