Skip to content

feat(quick-dev): clickable spec link at step-02 checkpoint and CWD-relative path convention#2049

Merged
alexeyv merged 1 commit intomainfrom
fix-clickable-spec-link-convention
Mar 18, 2026
Merged

feat(quick-dev): clickable spec link at step-02 checkpoint and CWD-relative path convention#2049
alexeyv merged 1 commit intomainfrom
fix-clickable-spec-link-convention

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 18, 2026

Summary

  • Step-02 CHECKPOINT 1 now displays the finalized spec file path as a CWD-relative clickable link after approval
  • Step-05 clarifies the dual path convention: project-root-relative (leading /) for spec-file content, CWD-relative (no leading /) for terminal/conversation output
  • One-shot review order explicitly uses CWD-relative path:line format instead of markdown links

Test plan

  • Run quick-dev-new-preview in plan-code-review mode — verify step-02 displays a clickable spec path after [A] approval
  • Verify step-05 Suggested Review Order links in spec files still use /-prefixed project-root-relative format
  • Run quick-dev-new-preview in one-shot mode — verify review order in conversation uses bare path:line format
  • Verify terminal paths are clickable (Cmd+click) in VS Code integrated terminal

🤖 Generated with Claude Code

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 18, 2026

🤖 Augment PR Summary

Summary: Updates the quick-dev workflow docs to improve path clickability by standardizing when to use CWD-relative vs project-root-relative paths.

Changes:

  • Step-02 now instructs showing the finalized spec path as a CWD-relative (terminal-clickable) link after approval
  • Step-05 clarifies the dual path convention and switches one-shot review order output to CWD-relative path:line format

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

**Plan-code-review:** Append the review order as a `## Suggested Review Order` section to `{spec_file}` **after the last existing section**. Do not modify the Code Map.

**One-shot:** Display the review order directly in conversation output.
**One-shot:** Display the review order directly in conversation output. Use CWD-relative `path:line` format (no leading `/`) instead of markdown links — conversation output must be terminal-clickable.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The one-shot instruction now says to output CWD-relative path:line without markdown links, but later guidance (e.g., rule #5 and the example block) still mandates markdown link formatting, which can lead to inconsistent/non-clickable one-shot output. Consider making the markdown-link requirements explicitly plan-code-review-only (or adding a one-shot-specific formatting section) so the instructions don’t conflict.

Severity: medium

Other Locations
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-05-present.md:30

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

📝 Walkthrough

Walkthrough

Standardizes path formatting in workflow documentation to use CWD-relative paths for terminal-clickable references and project-root-relative paths for spec-file links, improving consistency across two workflow markdown files.

Changes

Cohort / File(s) Summary
Path Format Standardization
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-02-plan.md, src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-05-present.md
Updated path formatting guidance to distinguish between CWD-relative paths (no leading slash) for terminal-clickable output and project-root-relative paths for spec-file links and code references. Enhanced clarity on which path format applies in different contexts (One-shot instructions, peripherals section, code references).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: adding a clickable spec link at step-02 and establishing a CWD-relative path convention, which align with the changeset.
Description check ✅ Passed The description clearly relates to the changeset, explaining the dual path convention and the modifications made to steps 02 and 05 with test plan details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Important

Merge conflicts detected (Beta)

  • Resolve merge conflict in branch fix-clickable-spec-link-convention
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-clickable-spec-link-convention
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-05-present.md`:
- Line 22: Update the two lowercase occurrences of the word "markdown" in the
document to "Markdown" for style consistency: find the occurrences that read
"markdown links" and "markdown" in the present step content (these exact token
strings) and replace them with "Markdown links" and "Markdown" respectively so
the phrasing is capitalized consistently throughout the step-05-present.md
content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 64ba745d-c1d9-4587-99c6-5eb0590ca5f5

📥 Commits

Reviewing files that changed from the base of the PR and between 0580164 and fcd7ae0.

📒 Files selected for processing (2)
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-02-plan.md
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-05-present.md

**Plan-code-review:** Append the review order as a `## Suggested Review Order` section to `{spec_file}` **after the last existing section**. Do not modify the Code Map.

**One-shot:** Display the review order directly in conversation output.
**One-shot:** Display the review order directly in conversation output. Use CWD-relative `path:line` format (no leading `/`) instead of markdown links — conversation output must be terminal-clickable.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Capitalize “Markdown” for style consistency.

Line 22 and Line 30 use “markdown” in lowercase; this should be “Markdown”.

Also applies to: 30-30

🧰 Tools
🪛 LanguageTool

[uncategorized] ~22-~22: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...ineformat (no leading/`) instead of markdown links — conversation output must be ter...

(MARKDOWN_NNP)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/step-05-present.md`
at line 22, Update the two lowercase occurrences of the word "markdown" in the
document to "Markdown" for style consistency: find the occurrences that read
"markdown links" and "markdown" in the present step content (these exact token
strings) and replace them with "Markdown links" and "Markdown" respectively so
the phrasing is capitalized consistently throughout the step-05-present.md
content.

@alexeyv alexeyv force-pushed the fix-clickable-spec-link-convention branch from fcd7ae0 to ec5028b Compare March 18, 2026 05:30
…D-relative path convention

Step-02 now displays the finalized spec file path as a CWD-relative
clickable link after approval. Step-05 clarifies the dual convention:
project-root-relative paths (leading /) for spec-file content, CWD-relative
paths (no leading /) for terminal/conversation output. One-shot review
order explicitly uses CWD-relative path:line format.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant