Skip to content

docs: restore comprehensive AGENTS.md with governance and technical s… - #189

Merged
timerloggedout-spec merged 1 commit into
masterfrom
docs/agents-md-comprehensive
Aug 12, 2026
Merged

timerloggedout-spec merged 1 commit into
masterfrom
docs/agents-md-comprehensive

Conversation

@timerloggedout-spec

@timerloggedout-spec timerloggedout-spec commented Aug 12, 2026 •

Copy link
Copy Markdown
Owner

reference #188

…ections

  • Governance & process rules (master-staging, gates, proposals)
  • Complete technical documentation (tokei stats, 28 tools, CI/CD)
  • Navigation hierarchy, core projects, development workflow
  • Methodology evolution, troubleshooting, 15 AI agent guidelines
  • References to DATA_FLOW_MANIFEST.md, SYSTEM_MAP.md

Open in Devin Review

…ections

- Governance & process rules (master-staging, gates, proposals)
- Complete technical documentation (tokei stats, 28 tools, CI/CD)
- Navigation hierarchy, core projects, development workflow
- Methodology evolution, troubleshooting, 15 AI agent guidelines
- References to DATA_FLOW_MANIFEST.md, SYSTEM_MAP.md
@blocksorg

blocksorg Bot commented Aug 12, 2026

Copy link
Copy Markdown

Mention Blocks like a regular teammate with your question or request:

@blocks review this pull request
@blocks make the following changes ...
@blocks create an issue from what was mentioned in the following comment ...
@blocks explain the following code ...
@blocks are there any security or performance concerns?

Run @blocks /help for more information.

Workspace settings | Disable this message

@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.

@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deployment failed for project termux-monorepo with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/timerloggedout-5184s-projects?upgradeToPro=build-rate-limit

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@timerloggedout-spec, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 5 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 806bf3ff-ff3e-4c5f-b2e7-9b2e2fb239e8

📥 Commits

Reviewing files that changed from the base of the PR and between 0b99526 and d0c128f.

📒 Files selected for processing (1)
  • AGENTS.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

@jules Auto-resolve (heyVern lane / GHA agent-review-auto-jules) — do not wait for a human ping.
Bot feedback from coderabbitai[bot] on PR #189 (branch docs/agents-md-comprehensive).

Feedback excerpt

<!-- This is an auto-generated comment: summarize by coderabbit.ai -->
<!-- This is an auto-generated comment: rate limited by coderabbit.ai -->

> [!WARNING]
> ## Review limit reached
> 
> `@timerloggedout-spec`, you've reached your PR review limit, so we couldn't start this review.
> 
> **Next review available in:** **5 minutes**
> 
> You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.
> 
> <details>
> <summary>How can I continue?</summary>
> 
> After more reviews become available, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR.
> 
> To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.
> 
> </details>
> 
> 
> <details>
> <summary>How do review limits work?</summary>
> 
> CodeRabbit enforces per-developer PR review limits for each organization. Most developers re

Instructions

  1. Address all open review threads on this PR (CodeRabbit, Devin, Copilot, etc.).
  2. Prefer minimal diffs; preserve Sentinel 0o600/0o700 if those files are touched.
  3. Push commits to branch docs/agents-md-comprehensive. Do not retarget away from the PR base without cause.
  4. If conflicts with base exist, resolve them.
  5. Skip pure nits only if they conflict with security/gates; otherwise apply autofixes.
    Monikers: docs/ops/AGENT-MONIKERS.md
    Agent: Grok (archW1z) orchestration · Profile: https://x.com/grok

@gitar-bot

gitar-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

Important

You are using the Gitar free plan. Upgrade to unlock code review, CI analysis, auto-apply, custom automations, and more.

Gitar

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can enable the Remediation agent and Qodo fixes findings in a dedicated fix PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@timerloggedout-spec
timerloggedout-spec merged commit 684f4e9 into master Aug 12, 2026
10 of 12 checks passed

@devin-ai-integration devin-ai-integration Bot left a comment

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.

Devin Review found 5 potential issues.

Open in Devin Review

Comment thread AGENTS.md
Comment on lines -31 to -36
## Debate & close

- Debate: MANIFEST Review log, optional DEBATE.md, linked PR/issue.
- Close: all items terminal + Review log outcome + move `active/` → `closed/` + registry update.
- Full rules: `docs/proposals/PROCESS.md` §§ consensus / closing.

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.

🔍 Governance "Debate & close" rules dropped from AGENTS.md

The rewrite removes the "Debate & close" block (debate via MANIFEST Review log / DEBATE.md; closing requires terminal items, Review log outcome, moving active/ → closed/, registry update). The PR describes itself as "restoring comprehensive" governance, but this section is net-deleted while nothing in the new text covers closing procedure. docs/proposals/PROCESS.md:51 still instructs agents to read AGENTS.md first, so agents relying on this file lose the close checklist. Worth confirming the deletion is intentional.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread AGENTS.md
- **Indices:** Stored in `workspace/llm_map/`, `archwiz/`, `cli-synthegration/workspace/`
- **Configuration:** Project-specific configs in respective directories
- **Backups:** `.bak` files created automatically, large JSONL indices backed up externally
- **Ignore Patterns:** Respect `.gitignore` and `.bobignore` (see root `.bobignore` for exclusions)

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.

🔍 Referenced ignore file .bobignore does not exist in the repo

The new conventions instruct agents to "Respect .gitignore and .bobignore (see root .bobignore for exclusions)", but there is no .bobignore at the repo root (verified by directory listing). Agent guideline 9 repeats the same reference at AGENTS.md:559. This will send agents looking for a nonexistent file.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread AGENTS.md
Comment on lines +364 to +369
### Commit Practices
- Use feature branches (`feature/*`) for all changes
- Never commit directly to `master` without review
- Reference task IDs in commit messages when applicable
- Keep commits focused and atomic
- Follow conventional commit format when possible

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.

🔍 Branch conventions in new section contradict the Hard Rules

The new "Commit Practices" and agent note 3 (AGENTS.md:553) say to use feature/* branches and never commit to master, while the Hard Rules above state integration work must target master-staging, and the Preferred Execution Loop says to branch from master-staging. The two sets of instructions are not reconciled, which can lead agents to open PRs against the wrong base branch.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread AGENTS.md
## Hard Rules

- Target **`master-staging`**, not raw `master`, for integration work.
- Both gates must pass before merge:

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.

🔍 Gate scripts cited in Hard Rules are absent from the repo

The retained Hard Rules require python3 scripts/ci/repo_gate.py and python3 scripts/ci/termux_smoke.py before merge, but scripts/ci/ currently only contains calculate_lag_index.py. Pre-existing, but since this PR is a documentation restoration it would be a good moment to either add the scripts or correct the paths.

(Refers to lines 21-23)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread AGENTS.md
Comment on lines +464 to +468
### Active PRs (as of 2026-08-01)
1. **PR #1 `critical-proposal`** - Critical eval + roadmap (mergeable as docs)
2. **PR #2 `timerloggedout-spec-patch-1`** - GHA Rust (narrow scope before merge)
3. **PR #3 `agent/repository-hygiene`** (draft) - Untrack session stores (**priority security**)

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.

📝 Info: Hard-coded statistics and "active PR" snapshot will go stale quickly

Tokei counts, file-count figures in the workspace tree, and the "Active PRs (as of 2026-08-01)" list are point-in-time snapshots baked into the guidance file. Agents are told to treat this file as authoritative first reading, so stale numbers/PR states may drive incorrect decisions. Consider marking these sections as generated/snapshot with a regeneration command.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Docs: restore comprehensive AGENTS.md (governance + technical guide)

📝 Documentation 🕐 20-40 Minutes

Grey Divider

AI Description

• Rebuild AGENTS.md with governance rules and an agent-first contribution workflow.
• Add a comprehensive technical overview: architecture, tools, CI/CD, indices, troubleshooting.
• Provide a navigation map linking key reference docs (SYSTEM_MAP, DATA_FLOW_MANIFEST, etc.).
Diagram

graph TD
A["AGENTS.md"] --> B["Governance rules"] --> C["docs/proposals/*"]
A --> D["Execution loop"] --> E["docs/PR-SUMMARY-PROCESS.md"]
A --> F["Navigation hub"] --> G["workspace/llm_map/SYSTEM_MAP.md"]
F --> H["archwiz/DATA_FLOW_MANIFEST.md"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Split AGENTS.md into separate governance + technical docs
  • ➕ Reduces file length and makes updates more localized
  • ➕ Allows different review/ownership for governance vs technical content
  • ➖ Creates more entry points for agents (harder onboarding)
  • ➖ Requires careful cross-linking to avoid drift
2. Keep AGENTS.md concise; move deep technical details to referenced indices
  • ➕ Minimizes staleness risk for fast-changing stats/tool lists
  • ➕ Makes AGENTS.md quicker to read and enforce
  • ➖ Less self-contained; agents may miss important operational details
  • ➖ Depends on other docs being maintained and discoverable
3. Generate technical sections from source-of-truth scripts/indices
  • ➕ Keeps stats/tool lists accurate with minimal manual maintenance
  • ➕ Encourages repeatable documentation updates
  • ➖ Adds build/automation complexity
  • ➖ Generated output can be noisy unless curated

Recommendation: The PR’s approach (single comprehensive entry point) is good for agent onboarding and operational consistency. To mitigate staleness, consider either (a) moving highly volatile facts (counts, active PR lists) into referenced docs, or (b) adding a lightweight regeneration/update process for the technical sections.

Files changed (1) +529 / -12

Documentation (1) +529 / -12
AGENTS.mdExpand AGENTS.md into governance-first + comprehensive technical guide +529/-12

Expand AGENTS.md into governance-first + comprehensive technical guide

• Reworks the top-level framing to emphasize governance/process first and standardizes headings. Adds an extensive technical documentation section covering project overview, navigation hierarchy, core projects, workflow/testing/CI, conventions, troubleshooting, and explicit guidelines for AI agents, with references to key system-map and data-flow docs.

AGENTS.md

@github-actions

Copy link
Copy Markdown
Contributor

head_sha: d0c128f
ready: true
autofix_requested: false
timed_out: false

Peer review gate (ready for second-pass agents)

External reviewers polled: CodeRabbit, Devin, Aikido, Sentry, Copilot.
Autofix (if any) was requested in a separate comment on this SHA.

Peer activity (truncated):

review @devin-ai-integration[bot] state=COMMENTED sha=d0c128f | comment @coderabbitai[bot]: <!-- This is an auto-generated comment: summarize by coderabbit.ai --> <!-- This is an auto-generated comment: rate limi

Downstream: gemini-after-peers. Jules: agent-review-auto-jules.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant