fix: formalize tags and related conventions in framework docs#25
Merged
fix: formalize tags and related conventions in framework docs#25
Conversation
Add explicit conventions for frontmatter tags and related fields to resolve ambiguity that caused inconsistent agent behavior. Tags: - kebab-case keywords, 3-8 per document - Describe topic, technology, component, or concern Related: - DevTrail document filenames only (with .md extension) - Include path from .devtrail/ for documents in subdirectories - Filename alone for same-directory or well-known documents - Explicitly prohibit task IDs, issue numbers, and URLs Updated files: - DOCUMENTATION-POLICY.md (EN + ES) - AGENT-RULES.md (EN + ES) - DEVTRAIL.md (unified rules) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolve ambiguity in frontmatter
tagsandrelatedfields that caused inconsistent behavior from AI agents (3 different formats coexisting inrelated, no formal convention fortags).Tags convention
[sqlite, persistence, hexagonal-architecture]Related convention
.mdextension).devtrail/for documents in subdirectoriesFiles updated
DOCUMENTATION-POLICY.md(EN + ES) — new subsections under metadataAGENT-RULES.md(EN + ES) — new rule in Document Format sectionDEVTRAIL.md— tags/related added to minimum metadata example🤖 Generated with Claude Code