Documentation Contributions
We understand that as we move quickly, sometimes our documentation website can be a bit outdated. Therefore, we highly value contributions to our documentation.
Prerequisites
How To Contribute
Fork The Repository
First, head over to the CopilotKit GitHub repository and create a fork.
Then, clone the forked repository to your local machine:
git clone https://github.com/<your-username>/CopilotKit
cd CopilotKit/docsRun the Documentation Site Locally
To run the documentation site locally, install the dependencies and then start the docs in development mode:
pnpm install
pnpm run devThe documentation site should be available at http://localhost:3000.
Make Your Changes
Now, you can make your changes to the documentation website.
- All documentation-related files are located in the docs repository
- You may want to familiarize yourself with Nextra to understand how the documentation website is structured.
Please ensure you review your changes for grammar, spelling and formatting errors. Also, ensure that links and images are working.
Review Changes & Submit Pull Request
Once you are happy with your changes, you can commit and push them. Then, head over to the Pull Requests page and create a pull request. Thank you for your contribution!
Need help?
If you need help with anything, please don't hesitate to reach out to us on Discord. We have a dedicated #contributing channel.
