Skip to content

Add documentation section to README #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
git-hulk merged 1 commit into from
Nov 23, 2025
Merged

Add documentation section to README #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,23 @@ $ ./_build/kvctl migrate slot 123 --target 1 -n test-ns -c test-cluster

For the HTTP API, you can find the [HTTP API(work in progress)](docs/API.md) for more details.

## Documentation

At the moment, there is no dedicated documentation page specifically for the Kvrocks Controller.
Most information is currently available in the source code and in the main Kvrocks documentation.

To help new contributors and users, here are the useful resources:

- Official Kvrocks Documentation:
https://kvrocks.apache.org/

- Configuration examples for the controller can be found inside the `config/` directory.

- API usage examples are provided in this README and in the source files under the `controller/` directory.

More structured and detailed documentation for the Kvrocks Controller will be added in the future.
Contributions to improve the documentation are always welcome.

## License

Licensed under the [Apache License, Version 2.0](LICENSE)
Loading