feat(dev.research): add vendor docs support - #5
Conversation
📝 WalkthroughWalkthroughAdds vendor documentation support to dev.research (template, workflow, path conventions), updates dev.loop commit guidance, extends meta.learn filename format to include a kebab-case task descriptor, and adds two .gitignore patterns for generated docs under Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
active/dev.research/SKILL.md (1)
25-26:⚠️ Potential issue | 🟡 MinorFix grammar in Root Directory sentence.
Use a plural verb and article for clarity.
✏️ Suggested diff
-All filepaths mentioned is relative to the $ROOT_DIR. Unless overridden elsewhere, the $ROOT_DIR is `./docs` (relative to the project root directorey) +All filepaths mentioned are relative to the $ROOT_DIR. Unless overridden elsewhere, the $ROOT_DIR is `./docs` (relative to the project root directory)
🧹 Nitpick comments (1)
active/dev.research/references/vendor-doc.md (1)
47-48: Add a language identifier to fenced code blocks.This will satisfy MD040 and improve readability in rendered docs.
🔧 Suggested diff
-``` +```md # API Reference: [Doc Name]-``` +```md # Topic: [Topic Name]Also applies to: 74-75
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@active/dev.research/SKILL.md`:
- Line 213: Change the pronoun in the sentence that references `$ROOT_DIR/` from
"them" to "it" so the singular pronoun agrees with the singular referent
`$ROOT_DIR/`; locate the sentence containing `$ROOT_DIR/` and replace "resolve
them relative to the project root directory" with "resolve it relative to the
project root directory".
In `@docs/specs/active/2026-02-01-support-vendor-docs-in-dev-research.md`:
- Line 4: The document shows "Status: Completed" but the success criteria
checkboxes remain unchecked; either verify and mark each success criteria as
done (check the boxes under the "success criteria" section) or change the
"Status: Completed" header to the accurate state (e.g., "In Progress" or
"Draft") until the criteria are validated; update the "Status: Completed" text
or toggle the checkbox items in the success criteria section so they are
consistent with each other.
🧹 Nitpick comments (3)
active/dev.research/references/vendor-doc.md (2)
59-80: Add language specifier to the fenced code block.The embedded Reference File Template code block should specify
markdownas the language for proper syntax highlighting and linter compliance.📝 Proposed fix
-``` +```markdown # API Reference: [Doc Name]
86-110: Add language specifier to the fenced code block.The embedded Topic File Template code block should specify
markdownas the language for proper syntax highlighting and linter compliance.📝 Proposed fix
-``` +```markdown # Topic: [Topic Name]docs/specs/active/2026-02-01-support-vendor-docs-in-dev-research.md (1)
95-98: Table column alignment.The markdown table has column alignment issues flagged by the linter. While this doesn't affect functionality, aligning the pipes improves readability.
📐 Proposed fix for table alignment
| Risk | Impact | Probability | Mitigation Strategy | |------|--------|-------------|---------------------| -| Vendor doc structure is ambiguous | Medium | Medium | Mirror issue text verbatim for directory and file placement rules. | -| Template conflicts with required ending sections | Low | Medium | Include required ending sections in vendor docs template to stay consistent with skill rules. | +| Vendor doc structure is ambiguous | Medium | Medium | Mirror issue text verbatim for directory and file placement rules. | +| Template conflicts with required ending sections | Low | Medium | Include required ending sections in vendor docs template to stay consistent with skill rules. |
| - `@references/vendor-doc.md` -> `dev.research/references/vendor-doc.md` | ||
|
|
||
| When you see `$ROOT_DIR/` referenced, resolve them relative to the project root directory. No newline at end of file | ||
| When you see `$ROOT_DIR/` referenced, resolve them relative to the project root directory. |
There was a problem hiding this comment.
Fix pronoun agreement.
The pronoun "them" doesn't agree with the singular referent $ROOT_DIR/. Should be "it" for grammatical correctness.
✍️ Proposed fix
-When you see `$ROOT_DIR/` referenced, resolve them relative to the project root directory.
+When you see `$ROOT_DIR/` referenced, resolve it relative to the project root directory.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| When you see `$ROOT_DIR/` referenced, resolve them relative to the project root directory. | |
| When you see `$ROOT_DIR/` referenced, resolve it relative to the project root directory. |
🤖 Prompt for AI Agents
In `@active/dev.research/SKILL.md` at line 213, Change the pronoun in the sentence
that references `$ROOT_DIR/` from "them" to "it" so the singular pronoun agrees
with the singular referent `$ROOT_DIR/`; locate the sentence containing
`$ROOT_DIR/` and replace "resolve them relative to the project root directory"
with "resolve it relative to the project root directory".
| # Execution Plan: Support Vendor Docs in dev.research | ||
|
|
||
| **Date:** 2026-02-01 | ||
| **Status:** Completed |
There was a problem hiding this comment.
Inconsistency between status and success criteria.
The document status is marked as "Completed" on line 4, but all success criteria on lines 117-120 remain unchecked. If the plan is complete, the success criteria should be verified and checked off to confirm the implementation meets all requirements.
✅ Proposed fix
## Success Criteria
-- [ ] `dev.research` skill includes vendor docs guidance and output structure.
-- [ ] New vendor docs template added under references.
-- [ ] Skill shortcuts include a workflow for creating vendor docs.
-- [ ] Documentation changes align with issue `#4` requirements.
+- [x] `dev.research` skill includes vendor docs guidance and output structure.
+- [x] New vendor docs template added under references.
+- [x] Skill shortcuts include a workflow for creating vendor docs.
+- [x] Documentation changes align with issue `#4` requirements.Also applies to: 117-120
🤖 Prompt for AI Agents
In `@docs/specs/active/2026-02-01-support-vendor-docs-in-dev-research.md` at line
4, The document shows "Status: Completed" but the success criteria checkboxes
remain unchecked; either verify and mark each success criteria as done (check
the boxes under the "success criteria" section) or change the "Status:
Completed" header to the accurate state (e.g., "In Progress" or "Draft") until
the criteria are validated; update the "Status: Completed" text or toggle the
checkbox items in the success criteria section so they are consistent with each
other.
…cs-in-dev-research feat(dev.research): add vendor docs support
1 participant
Summary
Testing
Summary by CodeRabbit
New Features
Chores
✏️ Tip: You can customize this high-level summary in your review settings.