Conversation
Add AI-assistant guidance files (AGENTS.md) at repository root and under vermeer, and expand documentation across the project: significantly update top-level README.md, computer/README.md, and vermeer/README.md with architecture, quick-starts, build/test instructions, and examples. Also update CI badge link in README and add AI-assistant-specific ignore patterns to .gitignore and vermeer/.gitignore to avoid tracking assistant artifacts.
dosubot
bot
added
the
size:XXL
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive AI-assistant guidance files and significantly expands documentation across the Apache HugeGraph-Computer project.
Changes:
- Added AGENTS.md files at repository root and vermeer/ subdirectory to guide AI coding assistants
- Significantly expanded README documentation for vermeer (Go in-memory engine) and computer (Java BSP framework)
- Updated top-level README with architecture diagrams, quick comparison table, and getting started guides
- Added AI-assistant-specific file patterns to .gitignore files to avoid tracking assistant artifacts
- Updated CI badge link from ci.yml to computer-ci.yml
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New AI assistant guidance file for the entire repository with build/test commands and architecture overview |
| .gitignore | Added patterns to ignore AI assistant files (CLAUDE.md, CURSOR.md, etc.) |
| README.md | Major rewrite with architecture diagrams, quick comparison table, detailed getting started guides for both Vermeer and Computer |
| vermeer/AGENTS.md | AI assistant guidance specific to Vermeer with Go-specific build commands and architecture details |
| vermeer/.gitignore | Added AI assistant file ignore patterns |
| vermeer/README.md | Complete documentation rewrite with mermaid architecture diagram, 20+ algorithms table, API examples, configuration guide, and troubleshooting |
| computer/README.md | Comprehensive documentation expansion including module structure, algorithm development guide, BSP coordination details, and K8s deployment instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
vermeer/README.md
Outdated
Comment on lines
230
to
246
| listen_addr = :6789 | ||
|
|
||
| # Master gRPC address to connect | ||
| master_peer = 127.0.0.1:6689 | ||
|
|
||
| # Worker ID (unique) | ||
| worker_id = worker01 | ||
|
|
||
| # Number of compute threads | ||
| compute_threads = 4 | ||
|
|
||
| # Memory limit (GB) | ||
| memory_limit = 8 | ||
|
|
||
| [storage] | ||
| # Local disk path for spilling | ||
| data_path = ./data |
There was a problem hiding this comment.
The worker configuration example uses incorrect parameter names. The actual configuration file uses http_peer, grpc_peer, and doesn't have sections like [worker] or [storage]. Please update the configuration example to match the actual parameter names and structure used in vermeer/config/worker.ini. The actual config has a [default] section with http_peer, grpc_peer, master_peer, and run_mode parameters.
Suggested change
| listen_addr = :6789 | |
| # Master gRPC address to connect | |
| master_peer = 127.0.0.1:6689 | |
| # Worker ID (unique) | |
| worker_id = worker01 | |
| # Number of compute threads | |
| compute_threads = 4 | |
| # Memory limit (GB) | |
| memory_limit = 8 | |
| [storage] | |
| # Local disk path for spilling | |
| data_path = ./data | |
| [default] | |
| # Worker HTTP listen address | |
| http_peer = 127.0.0.1:6789 | |
| # Worker gRPC listen address | |
| grpc_peer = 127.0.0.1:6790 | |
| # Master gRPC address to connect | |
| master_peer = 127.0.0.1:6689 | |
| # Run mode: worker or standalone | |
| run_mode = worker |
Comment on lines
+175
to
+185
| **Master (`config/master.ini`):** | ||
| - `http_peer`: Master HTTP listen address (default: 0.0.0.0:6688) | ||
| - `grpc_peer`: Master gRPC listen address (default: 0.0.0.0:6689) | ||
| - `run_mode`: Must be "master" | ||
| - `task_parallel_num`: Number of parallel tasks | ||
|
|
||
| **Worker (`config/worker.ini`):** | ||
| - `http_peer`: Worker HTTP listen address (default: 0.0.0.0:6788) | ||
| - `grpc_peer`: Worker gRPC listen address (default: 0.0.0.0:6789) | ||
| - `master_peer`: Master gRPC address to connect (must match master's `grpc_peer`) | ||
| - `run_mode`: Must be "worker" |
There was a problem hiding this comment.
The configuration documentation lists incorrect parameter names. The actual configuration files use http_peer and grpc_peer, not listen_addr. Please update lines 176-185 to match the actual configuration parameters in vermeer/config/master.ini and vermeer/config/worker.ini. The actual configs also don't have parameters like task_parallel_num, compute_threads, or memory_limit that are shown here.
Introduce .devin/wiki.json with repository notes directing contributors to focus exclusively on the vermeer directory: document its architecture, implementation, and APIs; exclude content from the computer module/directory; and prioritize vermeer-specific functionality and code examples.
Clarify algorithm parameters and configuration guidance across computer/README.md and vermeer/README.md. In computer/README.md PageRank options were renamed and documented (page_rank.alpha, bsp.max_superstep, pagerank.l1DiffThreshold) and a pointer to the full PageRank implementation was added to avoid confusion from the simplified example. In vermeer/README.md example Docker volume mounts now recommend a dedicated config directory (~/vermeer-config) and include a security note about avoiding mounting the whole home directory. The master.ini/worker.ini sample blocks were reworked to use revised keys (http_peer, grpc_peer, master_peer, run_mode, task_parallel_num, etc.) and a note clarifies that HugeGraph connection details are supplied via the graph load API. Additional notes direct readers to the real WorkerComputer/MasterComputer interfaces and existing algorithm examples; minor performance-tuning guidance was also adjusted to reflect the new task_parallel_num setting.
Pengzna
approved these changes
Jan 31, 2026
|
Related Documentation No published documentation to review for changes on this repository. Write your first living document How did I do? Any feedback? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add AI-assistant guidance files (AGENTS.md) at repository root and under vermeer, and expand documentation across the project: