Skip to content

Commit 50061d7

Browse files
fix: resolve pre-commit markdownlint issues
- Add trailing newlines to code-analyst.md, context_bootstrap.md, and information-analyst.md - Convert emphasis-as-heading to blockquote in research-synthesis.md - Fix bare URL by converting to markdown link in research-synthesis.md - Add 'text' language specifiers to all fenced code blocks in generate-codebase-context.md and PROGRESS.md Resolves CodeRabbit review feedback on PR #15 Co-authored-by: Gregg Coppen <[email protected]>
1 parent 27b548e commit 50061d7

File tree

6 files changed

+17
-15
lines changed

6 files changed

+17
-15
lines changed

docs/research/codebase-context/code-analyst.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,4 @@ You are running in a **subprocess** to do deep code analysis without overwhelmin
279279
Your findings will be combined with the Information Analyst's findings (from docs) to create complete context.
280280
281281
```
282+

docs/research/codebase-context/context_bootstrap.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,4 @@ You operate as the manager orchestrating two specialists:
5656
- **Code Analyst** – inspects source, dependencies, APIs, data models, integrations; returns summarized findings plus validation questions.
5757
- **Information Analyst** – reviews documentation artifacts, diagrams, and in-code commentary; returns inventories, rationale evidence, gaps, and conflicts.
5858
Keep subprocess outputs concise. Integrate their findings into user conversations and documentation.
59+

docs/research/codebase-context/information-analyst.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,3 +282,4 @@ You are running in a **subprocess** to do deep information extraction without ov
282282
Your findings will be combined with the Code Analyst's findings to create complete context. The Code Analyst tells the manager WHAT and HOW from code. You tell the manager WHY from documentation.
283283

284284
Together, you give the manager everything needed to write accurate PRDs, meaningful ADRs with rationale, and complete SYSTEM-OVERVIEW documentation.
285+

docs/research/codebase-context/research-synthesis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
### 🎯 Core Philosophy from context_bootstrap.md
2020

21-
**"Code explains HOW the system currently behaves; the user supplies WHAT it is supposed to achieve and WHY choices were made."**
21+
> "Code explains HOW the system currently behaves; the user supplies WHAT it is supposed to achieve and WHY choices were made."
2222
2323
This is **critical** - it separates:
2424

@@ -701,4 +701,4 @@ Ask targeted questions about:
701701
- **code-analyst.md:** Specialized agent for code analysis
702702
- **information-analyst.md:** Specialized agent for documentation analysis
703703
- **context_bootstrap.md:** Manager orchestration pattern
704-
- **MADR Format:** https://adr.github.io/madr/
704+
- **MADR Format:** [Architecture Decision Records (MADR)](https://adr.github.io/madr/)

docs/roadmap/PROGRESS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Explicitly flags items needing user validation.
103103

104104
Step-by-step flow examples:
105105

106-
```
106+
```text
107107
User Login Flow:
108108
1. POST /api/auth/login → src/api/routes/auth.ts:23
109109
2. AuthController.login() → src/controllers/AuthController.ts:45
@@ -149,7 +149,7 @@ Pre-completion verification:
149149

150150
### Files Added/Modified
151151

152-
```
152+
```text
153153
✅ prompts/generate-codebase-context.md (enhanced)
154154
✅ docs/research/reverse-engineer-prompts/claude-code-feature-dev-comparison.md (new)
155155
✅ docs/research/reverse-engineer-prompts/research-synthesis.md (new)

prompts/generate-codebase-context.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Trace from entry points to understand:
222222

223223
For key workflows, provide step-by-step execution trace:
224224

225-
```
225+
```text
226226
User Login Flow:
227227
1. POST /api/auth/login → src/api/routes/auth.ts:23
228228
2. AuthController.login() → src/controllers/AuthController.ts:45
@@ -256,7 +256,7 @@ From dependency files and imports, catalog:
256256

257257
**Evidence format:**
258258

259-
```
259+
```text
260260
- **Framework:** React (package.json:15, imports in src/components/*.tsx)
261261
- **Database:** PostgreSQL (package.json:23 'pg', connection in src/db/pool.ts:8)
262262
- **Cache:** Redis (docker-compose.yml:34, client in src/cache/redis.ts:12)
@@ -285,7 +285,7 @@ From dependency files and imports, catalog:
285285

286286
Example:
287287

288-
```
288+
```text
289289
- **API Service → Database:**
290290
- Method: Direct ORM queries
291291
- Evidence: src/services/UserService.ts:45 calls UserRepository.findById()
@@ -348,7 +348,7 @@ For each external integration found:
348348

349349
Example:
350350

351-
```
351+
```text
352352
- **Stripe (Payment Processing):**
353353
- Usage: Charges, subscriptions, webhooks
354354
- Evidence: src/services/PaymentService.ts:23-156
@@ -403,7 +403,7 @@ Ask 3-5 targeted questions based on gaps found:
403403

404404
Example:
405405

406-
```
406+
```text
407407
I found some gaps that need your input:
408408
409409
1. **PostgreSQL vs. MongoDB:**
@@ -426,7 +426,7 @@ I found some gaps that need your input:
426426

427427
**Capture answers as direct quotes:**
428428

429-
```
429+
```text
430430
[User confirmed: 2025-01-21: "MongoDB was from an early experiment, it's safe to remove."]
431431
[User stated: "JWT chosen because we needed stateless auth for mobile clients."]
432432
```
@@ -581,7 +581,7 @@ I found some gaps that need your input:
581581
### 4.2 Communication Patterns
582582

583583
**API → Services → Repositories → Database:**
584-
```
584+
```text
585585

586586
src/api/routes/users.ts:25 (HTTP endpoint)
587587
→ UserService.createUser() (src/services/UserService.ts:67)
@@ -591,7 +591,7 @@ src/api/routes/users.ts:25 (HTTP endpoint)
591591
```
592592

593593
**Event-Driven (Async):**
594-
```
594+
```text
595595
596596
PaymentService.processCharge() (src/services/PaymentService.ts:89)
597597
→ EventBus.publish('payment.processed') (src/events/bus.ts:23)
@@ -703,7 +703,7 @@ Priority files for anyone working on this codebase:
703703

704704
### Example 1: User Login
705705

706-
```
706+
```text
707707
708708
1. User submits credentials via POST /api/auth/login
709709
Entry: src/api/routes/auth.ts:23
@@ -737,7 +737,7 @@ Priority files for anyone working on this codebase:
737737

738738
### Example 2: Background Payment Processing
739739

740-
```
740+
```text
741741
742742
1. Webhook received from Stripe
743743
Entry: src/api/routes/webhooks/stripe.ts:12
@@ -862,7 +862,6 @@ After this context analysis:
862862
**Analysis completed:** YYYY-MM-DD
863863
**Last validated with user:** YYYY-MM-DD
864864
**Status:** Ready for feature specification
865-
```
866865

867866
---
868867

0 commit comments

Comments
 (0)