Skip to content

docs/fix: rewrite README, add walkthrough, and fix Aspire URL parsing - #8

Merged
NavneetHegde merged 2 commits into
mainfrom
fix/final-fixes
Mar 16, 2026
Merged

NavneetHegde merged 2 commits into
mainfrom
fix/final-fixes

Conversation

@NavneetHegde

Copy link
Copy Markdown
Owner

What changed

  • README.md — full rewrite with problem statement, proper architecture box-diagram, complete state machine diagram with retry paths, architecture highlights table, updated status (all 7 phases complete), and a "Future Extensions" section mapping each mock interface to an MCP/AI upgrade path
  • walkthrough.md (new) — 456-line annotated technical walkthrough covering Aspire orchestration, state machine, all three agents, approval callback, ETag concurrency, event schema, and full end-to-end sequence diagram
  • LICENSE.txt — filled in [year] [fullname] placeholder → 2026 Navneet Hegde
  • aspire-run.ps1 — fixed URL parser to handle Aspire login tokens that wrap across two console lines (narrow terminal edge case)
  • global.json — added rollForward: latestFeature so SDK version constraint accepts patch/feature updates without manual bumps

Why

README was outdated (phases 3–7 still marked "Planned") and lacked enough detail for a reader to understand the architecture at a glance. The walkthrough fills the gap with annotated code showing the design decisions behind each component. The aspire-run fix resolves a silent failure where the dashboard URL was never opened on narrow terminals.

How to test

  • Run aspire run .\appHost\apphost.cs — dashboard URL should auto-open in browser
  • Read README.md and walkthrough.md for correctness
  • dotnet test — all 83 tests pass, 40 Cosmos integration tests skip (emulator not running)

Screenshots

No UI changes — documentation and config only.

🤖 Generated with Claude Code

NavneetHegde and others added 2 commits March 15, 2026 22:58
- Rewrote README with problem statement, proper architecture diagrams,
  full state machine diagram with retry paths, architecture highlights
  table, and Future Extensions section mapping each mock interface to
  an AI/MCP upgrade point
- Updated implementation status to reflect all 7 phases complete
- Filled in LICENSE placeholder with 2026 Navneet Hegde
- Added walkthrough.md: 456-line annotated walkthrough covering Aspire
  orchestration, state machine, all three agents, callback endpoint,
  ETag concurrency, event schema, and full end-to-end sequence

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
aspire-run.ps1: the Aspire CLI sometimes wraps the login token across
two console lines when the terminal is narrow. The previous regex only
matched single-line URLs and silently dropped the dashboard URL. New
logic captures a partial URL and joins the continuation token on the
next line.

global.json: added rollForward=latestFeature so the SDK constraint
accepts patch/feature updates without requiring a manual version bump.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@NavneetHegde NavneetHegde added bug Something isn't working documentation Improvements or additions to documentation labels Mar 16, 2026

@NavneetHegde NavneetHegde left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

PR Review — fix/final-fixes → main

Commits

  • 5922d0e docs: rewrite README and add technical walkthrough
  • feae3de fix: handle wrapped Aspire dashboard URLs and add SDK rollForward

Files Changed

File Change
README.md Full rewrite — problem statement, architecture box-diagram, state machine diagram, highlights table, AI/MCP future extensions, updated phase status
walkthrough.md New file — 456-line annotated technical walkthrough of every component
LICENSE.txt Filled in [year] [fullname] placeholder
aspire-run.ps1 Fixed URL parser for wrapped Aspire login tokens across two console lines
global.json Added rollForward: latestFeature for SDK patch/feature tolerance

Test Results

Suite Passed Skipped Failed
Api.Tests 59 0 0
E2ETests 15 0 0
Infrastructure.Tests 9 40* 0

*Cosmos emulator integration tests skip without a running emulator — expected behaviour.

Branch is up to date with main. No new tests added (docs/config-only PR — no new code paths to cover).

Code Quality Scan

  • No secrets or hardcoded credentials
  • No debug/console code introduced
  • No TODO/FIXME comments left unresolved
  • No dead code or unused imports
  • aspire-run.ps1 fix is defensive — falls back to the partial URL if the next line isn't a bare token, so single-line URLs still work correctly

Potential Issues

  • aspire-run.ps1 edge case (minor, non-blocking): The wrapped-token logic sets $urlLaunched = $true even when the continuation line isn't a token (fallback path). This means a single-line URL followed by an unrelated line would correctly open the URL. Behaviour is correct; just worth noting the logic flow.
  • walkthrough.md code snippets: Snippets are illustrative (some use ... placeholders). Not a concern for a walkthrough doc, but readers should know these are excerpts, not verbatim compilable code.

Recommendation

Ready to merge

No blocking issues. Changes are documentation and config only — no risk to runtime behaviour. The aspire-run.ps1 fix resolves a real silent failure.

@NavneetHegde
NavneetHegde merged commit 3a6d94e into main Mar 16, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant