Skip to content

Docs: Document docs-writing.md #3569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
akamabu wants to merge 1 commit into from
+1 −0
Closed

Docs: Document docs-writing.md #3569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .claude/rules/docs-writing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- Documents .claude/rules/docs-writing.md module purpose and public usage context -->
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot May 13, 2026

Choose a reason for hiding this comment

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

🔴 HTML comment before YAML frontmatter breaks path-based rule filtering

The added HTML comment <!-- Documents ... --> on line 1 precedes the --- frontmatter delimiter. YAML frontmatter parsers require the opening --- to be on the very first line of the file. With content before it, the frontmatter block (paths: ["docs/**"]) will not be recognized, so Claude Code won't know this rule is scoped to docs/** files. Depending on the parser, the rule will either be ignored entirely or applied globally to all files instead of only docs. Every other rule file in .claude/rules/ correctly starts with --- on line 1.

Suggested change
<!-- Documents .claude/rules/docs-writing.md module purpose and public usage context -->
---
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

---
paths:
- "docs/**"
Expand Down