Skip to content

Commit 7d391f8

Browse files
committed
docs: move WORKFLOW.md to root and add prominence in agent docs
- Move docs/WORKFLOW.md to root for visibility - Add prominent callout in AGENTS.md and CLAUDE.md to read WORKFLOW.md first - Update all references to new location Ensures AI agents follow proper workflow (branches, commits, PRs) before starting work.
1 parent 6b97712 commit 7d391f8

File tree

5 files changed

+7
-3
lines changed

5 files changed

+7
-3
lines changed

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This file provides guidance to AI agents (Claude, Cursor, etc.) when working with the dev-agent codebase.
44

5+
> **⚠️ IMPORTANT: Before starting any implementation work, read [`WORKFLOW.md`](./WORKFLOW.md) for the development workflow, including branch naming, commit format, PR process, and testing standards.**
6+
57
## Project Overview
68

79
**Dev-Agent** is a local-first repository context provider for AI tools. It provides semantic code search, GitHub integration, and development planning capabilities through the Model Context Protocol (MCP).
@@ -360,7 +362,7 @@ pnpm build
360362
## Resources
361363

362364
- **Architecture:** See `ARCHITECTURE.md`
363-
- **Workflow:** See `docs/WORKFLOW.md`
365+
- **Workflow:** See `WORKFLOW.md`
364366
- **Examples:** See `examples/` directory
365367
- **Troubleshooting:** See `TROUBLESHOOTING.md` (coming soon)
366368
- **Contributing:** See `CONTRIBUTING.md`

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5+
> **⚠️ IMPORTANT: Before starting any implementation work, read [`WORKFLOW.md`](./WORKFLOW.md) for the development workflow, including branch naming, commit format, PR process, and testing standards.**
6+
57
## Project Overview
68

79
Dev-Agent is a local-first repository context provider for AI tools like Claude Code. It helps AI tools understand codebases without hallucinations by providing semantic search, code analysis, and GitHub integration through a monorepo architecture.
File renamed without changes.

packages/mcp-server/CLAUDE_CODE_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ No need to reinstall MCP integration - it automatically uses the latest version.
359359
## Next Steps
360360

361361
- See [README.md](./README.md) for MCP server architecture
362-
- See [../../docs/WORKFLOW.md](../../docs/WORKFLOW.md) for development workflow
362+
- See [../../WORKFLOW.md](../../WORKFLOW.md) for development workflow
363363
- See [TROUBLESHOOTING.md](../../TROUBLESHOOTING.md) for detailed troubleshooting
364364

365365
## Need Help?

packages/mcp-server/CURSOR_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ No need to reinstall MCP integration - it automatically uses the latest version.
338338
## Next Steps
339339

340340
- See [README.md](./README.md) for MCP server architecture
341-
- See [../../docs/WORKFLOW.md](../../docs/WORKFLOW.md) for development workflow
341+
- See [../../WORKFLOW.md](../../WORKFLOW.md) for development workflow
342342
- See [TROUBLESHOOTING.md](../../TROUBLESHOOTING.md) for detailed troubleshooting
343343

344344
## Need Help?

0 commit comments

Comments
 (0)