lablup / lablup/backend.ai

Refresh stale component READMEs against verified runtime facts

Open
#13,650 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
670
Forks
183
Avg merge
15h 13m
Merged PRs (30d)
368

Description

Fix component README statements that contradict the code, found while writing the KNOWLEDGE.md coverage (BA-7303).

Verified stale points: agent/README.md claims RPC port 6011 (actual 6001) and mischaracterizes the watcher direction as Agent-to-Manager HTTP; storage/README.md describes a directory tree that no longer exists (vfs/ top level, services/vfolder.py) and a generic per-folder quota story instead of the quota-scope model with CAP_QUOTA; appproxy READMEs claim gRPC support (REST only), stale ports (6120/6130/6030/6040/5050 vs actual 10200/10201/10205-10300), a coordinator-to-worker health probe (actual: worker-to-coordinator ping), and etcd circuit paths (circuits live in the coordinator DB and travel over the event bus); common/events/README.md claims DLQ support and retry backoff that do not exist (retries are capped then dropped, no DLQ).

The corresponding KNOWLEDGE.md documents carry the correct facts; this issue aligns the human-facing READMEs with them.

JIRA Issue: BA-7306

Contributor guide

Open the contributing guide

Research direction

Start with the corresponding KNOWLEDGE.md entries, then compare agent/README.md, storage/README.md, the appproxy READMEs, and common/events/README.md against the verified runtime facts in the issue. Update each stale statement about ports, request direction, quota scope, protocol support, circuit storage, and retry behavior; done means the component READMEs no longer contradict those documented facts.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.