docs: fix stale doc references#18
Merged
Merged
Conversation
goanpeca
added
the
B2 Example
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to eliminate stale references called out in issue #16 by ensuring referenced paths exist and correcting E2E test location guidance.
Changes:
- Added
docs/exec-plans/active/(via a tracked placeholder file) so “active plan” documentation references resolve. - Updated
docs/dev-workflows.mdto reference the correct AGENTS.md section for doc update mapping and to point E2E placement toapps/web/e2e/with config inapps/web/playwright.config.ts. - Refreshed
<!-- last_verified -->headers in affected docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/exec-plans/active/.gitkeep | Adds a tracked placeholder so the documented docs/exec-plans/active/ path exists in-repo. |
| docs/dev-workflows.md | Fixes section references and corrects E2E test placement/config documentation. |
| AGENTS.md | Updates last_verified to reflect the documentation refresh date. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
docs/exec-plans/active/directory so documented active-plan references resolve.apps/web/e2e/and its Playwright config.Linked issue
Tests run
/Users/gpenacastellanos/miniforge3/condabin/mamba run -n vibe-starter-kit-issue-16 pnpm lint/Users/gpenacastellanos/miniforge3/condabin/mamba run -n vibe-starter-kit-issue-16 sh -lc "test -d docs/exec-plans/active && rg -F 'E2E: \apps/web/e2e/`' docs/dev-workflows.md && ! rg -F 'E2E: project root' AGENTS.md docs/dev-workflows.md"`/Users/gpenacastellanos/miniforge3/condabin/mamba run -n vibe-starter-kit-issue-16 sh -lc "! rg -F 'AGENTS.md §8' docs/dev-workflows.md && rg -F 'AGENTS.md §9' docs/dev-workflows.md"git diff --checkFollow-up notes