docs: add AGENTS.md and update docs & gitignore; fix some mistakes#345
Merged
imbajin merged 1 commit intoapache:docsfrom Jan 31, 2026
Merged
docs: add AGENTS.md and update docs & gitignore; fix some mistakes#345imbajin merged 1 commit intoapache:docsfrom
imbajin merged 1 commit intoapache:docsfrom
Conversation
dosubot
bot
added
the
size:XXL
Ethereal-O
changed the title
dosubot
bot
added
size:M
imbajin
approved these changes
Jan 31, 2026
imbajin
added a commit
that referenced
this pull request
Feb 1, 2026
* docs: add AGENTS.md and update docs & gitignore 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. * Add vermeer-focused .devin/wiki.json 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. * Update READMEs: PageRank params and Vermeer configs 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. * Update README.md * doc: fix some mistakes in docs about vermeer (#345) --------- Co-authored-by: Jingkai Yang <m15635418665@163.com>
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
2 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:
significantly update top-level README.md, computer/README.md
vermeer/README.md with architecture, quick-starts, build/test instructions, and examples
update CI badge link in README
AI-assistant-specific ignore patterns to .gitignore and vermeer/.gitignore to avoid tracking assistant artifacts.
Check and fix some mistakes in guidance files.