Skip to content

docs(may-agent): INDEX.md — document guide, cross-reference matrix, and status dashboard#22

Open
Fearvox wants to merge 7 commits into
mainfrom
sleep-iter-17-may-agent-index
Open

docs(may-agent): INDEX.md — document guide, cross-reference matrix, and status dashboard#22
Fearvox wants to merge 7 commits into
mainfrom
sleep-iter-17-may-agent-index

Conversation

@Fearvox
Copy link
Copy Markdown
Owner

@Fearvox Fearvox commented May 13, 2026

Summary

  • Complete document index for the 6-document May Agent architecture set
  • 3 reading paths: Executive (30 min), Developer (2 hrs), Reviewer (60 min)
  • Cross-document reference matrix (26 topics × 6 docs)
  • 10 key decisions with source document and section locations
  • Document relationship diagram and gap analysis table
  • Status dashboard tracking review state of all docs

Test plan

  • All 6 documents referenced with correct PR numbers
  • 3 reading paths cover all stakeholder roles
  • Cross-reference matrix covers all major topics
  • Key decisions link back to primary source documents

🤖 Generated with Claude Code

Fearvox and others added 7 commits May 13, 2026 01:25
…lack mirror sync

Adds two issue templates under .github/ISSUE_TEMPLATE/ for long-lived,
auditable mirrors of in-flight upstream PRs:

- pr_tracker.yml: general PR mirror (scope, evidence, decision log, closure)
- security_tracker.yml: high-priority variant (CWE, severity, reachability,
  verification, disclosure hygiene)

Both carry a `pr-mirror` label so the Linear evermind-dash project and the
Slack #bots channel can subscribe by label. Bilingual EN + 中文.
…tream

Runs every 6 hours via cron + manual workflow_dispatch.
- Rebases fork main onto upstream/main (preserves fork-only commits like
  the issue templates)
- Force-pushes with --force-with-lease for safety
- Opens a tracking issue on conflict instead of failing silently

Uses default GITHUB_TOKEN — no PAT needed since we only push to fork.
Triggers on issues.opened and issues.labeled. When pr-mirror label is
present, creates a corresponding Linear issue in the EverMind-Dash
project via Linear GraphQL API. Comments back on GitHub with the
EVE-id link.

Idempotency: skips if a '🔗 Linear:' marker comment already exists.
Priority: 'urgent' label -> Linear urgent (1); otherwise medium (3).
On API failure: applies 'sync-failed' label for triage.

Requires (configured separately):
  Secret:   LINEAR_API_KEY    (Linear Personal API key, lin_api_*)
  Vars:     LINEAR_TEAM_ID    (EverMind team UUID)
            LINEAR_PROJECT_ID (EverMind-Dash project UUID)
…nnel

Update the disclosure-hygiene checkbox to reference #p-evermind-dash
(the actual Slack channel linked to the EverMind-Dash Linear project)
instead of the placeholder #bots.
…ents

Two compounding fixes to avoid creating multiple Linear issues from a
single GitHub issue creation:

1. concurrency group keyed on issue.number with cancel-in-progress=false
   serializes runs per issue. Second run will see the first run's
   comment and skip via existing idempotency check.

2. Tighten 'labeled' event filter to only fire when the added label is
   pr-mirror itself, not any other label. Eliminates the four extra
   runs that gh issue create --label A --label B ... triggers (one
   issues.opened + four issues.labeled = 5 events for a 4-label create).

Reproduction: gh issue create with 4 labels including pr-mirror was
firing the workflow 5 times concurrently. Idempotency check has a
~5s race window before the first run posts its bot comment, so 2-3
runs created duplicate Linear issues before the rest skipped.

Verified via Issue #4 sync producing both EVE-3 and EVE-4.
Adds the fork overnight patrol workflow, Linear-aware tracking issue creation, and docs guard support for coming-soon use-case placeholders. Verified with local script checks and passing Docs CI.
…ross-reference matrix

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 13, 2026 07:23
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new documentation index for the “May Agent” architecture doc set, intended to provide a reading guide, cross-document reference matrix, and review/status dashboard for the associated design documents.

Changes:

  • Introduces .planning/may-agent/INDEX.md with a document manifest, role-based reading paths, and a cross-document topic matrix.
  • Adds a “Key Decisions” locator table plus relationship diagram, gap analysis, and status dashboard.
  • Lists reference pointers into the broader repo (EverCore entry/controllers) and other planning artifacts.
Comments suppressed due to low confidence (1)

.planning/may-agent/INDEX.md:153

  • These reference paths don’t exist in the repository (.planning/hermes-recon/architecture.md, CLAUDE_DESKTOP_SANDBOX_SOURCE_TRUTH.md, and .planning/SLEEP_LOG.md are all missing). Please either add the referenced files or update/remove these bullets so readers aren’t sent to broken links.
- Hermes recon: `.planning/hermes-recon/architecture.md`
- EverCore entry: `methods/EverCore/src/run.py`
- EverCore controllers: `methods/EverCore/src/infra_layer/adapters/input/api/`
- CLAUDE_DESKTOP_SANDBOX_SOURCE_TRUTH.md (macOS sandbox forensics)
- Sleep run log: `.planning/SLEEP_LOG.md`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +16 to +20
| # | File | Lines | PR | Subject |
|---|------|-------|-----|---------|
| 00 | `00-vision.md` | 141 | #16 | Strategy, decision matrix, success criteria |
| 10 | `10-architecture.md` | 264 | #17 | System design, mermaid diagrams, data flow |
| 20 | `20-rust-runtime-scaffold.md` | 305 | #18 | Crate structure, async traits, build pipeline |
@Fearvox Fearvox marked this pull request as draft May 13, 2026 09:23
@Fearvox Fearvox added pr-mirror Long-lived mirror of an upstream PR for Linear/Slack tracking tracking Issue tracks a long-lived workflow labels May 13, 2026
@Fearvox Fearvox marked this pull request as ready for review May 20, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-mirror Long-lived mirror of an upstream PR for Linear/Slack tracking tracking Issue tracks a long-lived workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants