docs/fix: rewrite README, add walkthrough, and fix Aspire URL parsing - #8
Merged
Merged
Conversation
- 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
commented
Mar 16, 2026
NavneetHegde
left a comment
Owner
Author
There was a problem hiding this comment.
PR Review — fix/final-fixes → main
Commits
5922d0edocs: rewrite README and add technical walkthroughfeae3defix: 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.ps1fix 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 = $trueeven 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
[year] [fullname]placeholder →2026 Navneet HegderollForward: latestFeatureso SDK version constraint accepts patch/feature updates without manual bumpsWhy
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
aspire run .\appHost\apphost.cs— dashboard URL should auto-open in browserdotnet 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