mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
12d3492e0c
* feat: add link auditor tools and fix broken docs links - Add audit-doc-links.js to scan docs for broken links with auto-resolution - Add fix-doc-links.js to apply suggested fixes (dry-run by default) - Remove stale "Back to Core Concepts" breadcrumb links - Update BMad acronym to "Breakthrough Method of Agile AI Driven Development" - Update README links to docs.bmad-method.org - Simplify upgrade callout in getting-started tutorial Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: reorganize docs structure and archive v4 tutorial - Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: ignore underscore directories in link checker Update check-doc-links.js to skip _archive, _planning, and other underscore-prefixed directories when validating links. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add v4 users section to README Add links to v4 documentation archive and upgrade guide for users migrating from previous versions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: convert docs to site-relative links and add validation tools - Convert all relative links (./ ../) to site-relative paths (/path/) - Strip .md extensions and use trailing slashes for Astro/Starlight - Add fix-doc-links.js to convert relative links to site-relative - Add validate-doc-links.js to check links point to existing files - Remove old audit-doc-links.js and check-doc-links.js - Update build-docs.js to use new validation script - Add npm scripts: docs:fix-links, docs:validate-links - Update style guide with validation steps Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize acronym to BMad across documentation Replace incorrect "BMAD" with correct "BMad" in text and frontmatter while preserving "BMAD-METHOD" in GitHub URLs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: fix BMad acronym and remove draft README - Correct acronym to "Breakthrough Method of Agile AI Driven Development" - Remove unused README-draft.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize BMad acronym in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize FAQ format across all FAQ pages - Add TOC with jump links under "## Questions" - Use ### headers for questions (no Q: prefix) - Direct answers without **A:** prefix - Remove horizontal rules and "Related Documentation" sections - End each FAQ with issue/Discord CTA - Update style guide with new FAQ guidelines - Delete redundant faq/index.md (sidebar handles navigation) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use repo-relative links with .md for GitHub compatibility Convert all documentation links to repo-relative format (/docs/path/file.md) so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix and converts .md to trailing slash at build time for Astro/Starlight. - Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths - Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension - Convert 217 links across 64 files to new format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle /docs/ prefix in link validator Update resolveLink to strip /docs/ prefix from repo-relative links before checking if files exist. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: restore FAQ index page Re-add the FAQ index page that was accidentally deleted, with updated repo-relative link format. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
2.9 KiB
2.9 KiB
title, description
| title | description |
|---|---|
| How to Implement a Story | How to implement a story using the dev-story workflow |
Use the dev-story workflow to implement a story with tests following the architecture and conventions.
When to Use This
- After create-story has prepared the story file
- When ready to write code for a story
- Story dependencies are marked DONE
Prerequisites
- BMad Method installed
- DEV agent available
- Story file created by create-story
- Architecture and tech-spec available for context
Steps
1. Load the DEV Agent
Start a fresh chat and load the DEV agent.
2. Run the Workflow
*dev-story
3. Provide Story Context
Point the agent to the story file created by create-story.
4. Implement with Guidance
The DEV agent:
- Reads the story file and acceptance criteria
- References architecture decisions
- Follows existing code patterns
- Implements with tests
5. Complete Implementation
Work with the agent until all acceptance criteria are met.
What Happens
The dev-story workflow:
- Reads context - Story file, architecture, existing patterns
- Plans implementation - Identifies files to create/modify
- Writes code - Following conventions and patterns
- Writes tests - Unit, integration, or E2E as appropriate
- Validates - Runs tests and checks acceptance criteria
Key Principles
One Story at a Time
Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
Follow Architecture
The DEV agent references:
- ADRs for technology decisions
- Standards for naming and structure
- Existing patterns in the codebase
Write Tests
Every story includes appropriate tests:
- Unit tests for business logic
- Integration tests for API endpoints
- E2E tests for critical flows
After Implementation
- Update sprint-status.yaml - Mark story as READY FOR REVIEW
- Run code-review - Quality assurance
- Address feedback - If code review finds issues
- Mark DONE - After code review passes
Tips
- Keep the story file open for reference
- Ask the agent to explain decisions
- Run tests frequently during implementation
- Don't skip tests for "simple" changes
Troubleshooting
Q: Story needs significant changes mid-implementation?
A: Run correct-course to analyze impact and route appropriately.
Q: Can I work on multiple stories in parallel? A: Not recommended. Complete one story's full lifecycle first.
Q: What if implementation reveals the story is too large? A: Split the story and document the change.
Related
- Create Story - Prepare the story first
- Run Code Review - After implementation
- Run Sprint Planning - Sprint organization