https://github.com/kernel/docs
Documentation for kernel.sh/docs
https://github.com/kernel/docs
documentation mdx mintlify
Last synced: 2 days ago
JSON representation
Documentation for kernel.sh/docs
- Host: GitHub
- URL: https://github.com/kernel/docs
- Owner: kernel
- License: mit
- Created: 2025-06-13T15:41:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-07-01T23:48:33.000Z (3 days ago)
- Last Synced: 2026-07-02T01:22:32.566Z (3 days ago)
- Topics: documentation, mdx, mintlify
- Language: MDX
- Homepage: https://kernel.sh/docs
- Size: 7.06 MB
- Stars: 6
- Watchers: 0
- Forks: 9
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.mdx
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: security-vulnerability-reporting.mdx
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Kernel Documentation
This is the documentation for the Kernel platform. It's connected to [onkernel.com/docs](https://onkernel.com/docs).
## Code Snippets
Code samples in the docs are authored inline in MDX. Keep SDK examples aligned with the SDK repos, and follow the standards in `.docs/code-example-guide.md` when adding or editing examples.
When you add Go examples:
- Test complete snippets, or wrapped focused snippets, against the minimum released Go SDK version
that supports the API you're documenting.
- Run `gofmt` on complete snippets and on wrapper files used to validate focused snippets before
publishing.
- Note the validation you ran in the pull request description.
## Local Development
To run the docs locally, you can use the following command:
```bash
mintlify dev
```
## Contributing
We welcome contributions to the documentation. Please feel free to submit a pull request with your changes. See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.