Skip to content

docs: add eval and Aspire walkthrough#3508

Open
rysweet wants to merge 3 commits intomainfrom
feat/issue-3507-add-eval-aspire-walkthrough-docs
Open

docs: add eval and Aspire walkthrough#3508
rysweet wants to merge 3 commits intomainfrom
feat/issue-3507-add-eval-aspire-walkthrough-docs

Conversation

@rysweet
Copy link
Owner

@rysweet rysweet commented Mar 24, 2026

Summary

  • add a five-minute walkthrough to the eval explanation doc so the chat handoff lives in durable docs
  • explain where the authoritative local CLI fits, why the Aspire AppHost is in C#, and how EH_CONN is handed to local AppHost-run monitor and eval resources without going through argv
  • strengthen the overview doc link text so the new walkthrough is easier to discover

Closes #3507

Validation

  • pre-commit run --files docs/hive_mind/EVAL_COMPONENTS.md docs/hive_mind/EVAL.md
  • python scripts/validate_docs_navigation.py

Local environment limits

  • python scripts/validate_gh_pages_links.py --local docs/ --pragmatic could not run locally because the available Python environments here do not have bs4
  • make docs-build could not run locally because mkdocs is not installed in the available Python environments
  • the corresponding CI jobs on the PR are expected to run the authoritative docs checks

Ubuntu and others added 2 commits March 24, 2026 04:31
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor

Repo Guardian - Passed

All changed files in this PR contain durable reference material. No ephemeral content or temporary scripts detected.

File Assessment
docs/hive_mind/EVAL.md Minor link description update — durable reference doc
docs/hive_mind/EVAL_COMPONENTS.md New sections explaining stack architecture, CLI ownership, Aspire AppHost rationale, and secrets handling — all durable architectural documentation

No action required.

Generated by Repo Guardian for issue #3508 ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rysweet rysweet marked this pull request as ready for review March 24, 2026 04:41
@github-actions
Copy link
Contributor

🤖 PM Architect PR Triage Analysis

PR: #3508
Title: docs: add eval and Aspire walkthrough
Author: @rysweet
Branch: feat/issue-3507-add-eval-aspire-walkthrough-docsmain


✅ Workflow Compliance (Steps 11-12)

NON-COMPLIANT - PR needs workflow completion

Step 11 (Review): ❌ Incomplete

  • Insufficient review evidence. Found 0 formal reviews and 1 comments. Review score: 0 (need >= 5). Comprehensive review detected: False

Step 12 (Feedback): ❌ Incomplete

  • Insufficient feedback implementation. Response score: 0 (need >= 3)

Blocking Issues:

  • Step 11 incomplete: Need comprehensive code review with security, quality, and philosophy checks
  • Step 12 incomplete: Need to address and respond to review feedback

🏷️ Classification

Priority: LOW

  • Documentation or minor cleanup

Complexity: MODERATE

  • 2 files with 36 lines changed

🔍 Change Scope Analysis

FOCUSED CHANGES - All changes are related to PR purpose

Purpose: New feature

💡 Recommendations

  • Complete workflow steps 11-12 before marking PR as ready
  • Add at least one formal code review

📊 Statistics

  • Files Changed: 2
  • Comments: 1
  • Reviews: 0

🤖 Generated by PM Architect automation using Claude Agent SDK

@github-actions
Copy link
Contributor

Repo Guardian - Passed

All changed files in this PR contain durable reference material. No ephemeral content or temporary scripts detected.

File Assessment
docs/hive_mind/EVAL.md Minor link description clarification — durable reference doc
docs/hive_mind/EVAL_COMPONENTS.md Added sections covering five-minute walkthrough, CLI ownership, Aspire AppHost rationale, and secrets handling — all durable architectural documentation

No action required.

Generated by Repo Guardian for issue #3508 ·

@github-actions
Copy link
Contributor

PR Triage Report

Classification: Documentation | Risk: Low | Priority: Medium

Assessment

Dimension Result
Author rysweet
Scope Docs only — docs/hive_mind/EVAL_COMPONENTS.md, docs/hive_mind/EVAL.md
Risk Low — no code changes
Tests Validation scripts referenced but blocked locally (bs4, mkdocs unavailable) — CI expected to run authoritative checks
Closes #3507
Conflicts None

Changes

  • Adds 5-minute eval + Aspire walkthrough to EVAL_COMPONENTS.md
  • Explains why Aspire AppHost is in C# and how EH_CONN is passed to monitor/eval resources
  • Strengthens overview doc link text for discoverability
  • Clarifies authoritative local CLI fit

Gaps / Notes

  • validate_gh_pages_links.py and make docs-build not run locally — reviewer should confirm CI passes
  • PR body references pre-commit validation: pre-commit run --files docs/hive_mind/EVAL_COMPONENTS.md docs/hive_mind/EVAL.md

Recommendation

Needs review — low risk doc-only PR closing a tracked issue. Verify CI doc checks pass, then approve.

Generated by PR Triage Agent ·

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add explicit eval and Aspire walkthrough to docs

1 participant