This is an automated email from the ASF dual-hosted git repository.
hulk pushed a commit to branch unstable
in repository https://gitbox.apache.org/repos/asf/kvrocks-controller.git
The following commit(s) were added to refs/heads/unstable by this push:
new 083b05a Add documentation section to README (#368)
083b05a is described below
commit 083b05aebc8964d86a9b3dd0161c1b0bbb4ad653
Author: ALOK KUMAR <[email protected]>
AuthorDate: Sun Nov 23 17:30:21 2025 +0530
Add documentation section to README (#368)
---
README.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.md b/README.md
index 502b43a..ad0d46c 100644
--- a/README.md
+++ b/README.md
@@ -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)
