Skip to content

docs: launch docs site and trim README#61

Merged
fanyang89 merged 5 commits into
mainfrom
docs-site
Mar 31, 2026
Merged

docs: launch docs site and trim README#61
fanyang89 merged 5 commits into
mainfrom
docs-site

Conversation

@fanyang89
Copy link
Copy Markdown
Owner

Add documentation site as a git submodule and replace the verbose README

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@fanyang89 fanyang89 merged commit af824e7 into main Mar 31, 2026
2 checks passed
@fanyang89 fanyang89 deleted the docs-site branch March 31, 2026 13:42
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
[![zread][ask-zread]](https://zread.ai/fanyang89/raftpp)

## Features
A modern C++ implementation of the RAFT consensus algorithm.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
A modern C++ implementation of the RAFT consensus algorithm.
A modern C++23 implementation of the RAFT consensus algorithm.

Comment thread README.md
- C++23 compiler (GCC 13+, Clang 17+)
- CMake 3.20+
- Ninja (recommended)
**https://raftpp.cc**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using a proper Markdown link for the documentation URL makes it more professional and ensures it is clickable in all environments. Additionally, using the domain name as the link text is often cleaner than a bare URL.

Suggested change
**https://raftpp.cc**
**[raftpp.cc](https://raftpp.cc)**

Comment thread README.md
Comment on lines +16 to +18
task cmake
task build
task test
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
task cmake
task build
task test
task cmake # Configure CMake with dev preset
task build # Build all targets
task test # Run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant