Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Code Review
This pull request moves the project's detailed documentation, architecture diagrams, and quick-start guides from the README into a separate 'docs' submodule and a dedicated website (raftpp.cc). The README has been significantly streamlined to serve as a high-level landing page. Feedback focuses on restoring critical information to the README for better developer experience, specifically the C++23 version requirement and explanatory comments for the custom build tasks, as well as improving the formatting of the documentation link.
| [![zread][ask-zread]](https://zread.ai/fanyang89/raftpp) | ||
|
|
||
| ## Features | ||
| A modern C++ implementation of the RAFT consensus algorithm. |
There was a problem hiding this comment.
The specific C++ version requirement (C++23) was removed from the description. It is highly recommended to keep this information in the README so users can immediately determine if their environment is compatible without having to visit the full documentation site.
| A modern C++ implementation of the RAFT consensus algorithm. | |
| A modern C++23 implementation of the RAFT consensus algorithm. |
| - C++23 compiler (GCC 13+, Clang 17+) | ||
| - CMake 3.20+ | ||
| - Ninja (recommended) | ||
| **https://raftpp.cc** |
There was a problem hiding this comment.
| task cmake | ||
| task build | ||
| task test |
There was a problem hiding this comment.
The task commands (from go-task) are used here without explanation. Restoring the brief comments from the previous version helps users understand what each command does, especially since task is not a standard tool in the C++ ecosystem.
| task cmake | |
| task build | |
| task test | |
| task cmake # Configure CMake with dev preset | |
| task build # Build all targets | |
| task test # Run all tests |
Add documentation site as a git submodule and replace the verbose README