Conversation
…e (MT-45) Create docs/conventions/documentation/ directory with structured files: - README.md: Overview of documentation types with links - readme-guide.md: Templates for project, directory, package READMEs - root-documentation.md: Files outside docs/ (AGENTS.md, SKILL.md, etc.) - docs-structure.md: Category-based vs topic-based organization - docs-structure-concepts.md: Diátaxis framework background - command-usage.md: CLI help text and reference doc templates - writing-style.md: Markdown, tone, formatting conventions Key changes: - Lead with package recommendations (simple topic-based) - Add file suffixes convention (-guide, -reference, -concepts) - Define AGENTS.md as industry standard for AI agent instructions - Add docs/commands/ pattern for command reference - Update SKILL.md to reference new documentation structure 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- AGENTS.md: Reduce to 3 lines pointing to SKILL.md (was 46 lines) - CLAUDE.md: Point to /metool skill (was pointing to AGENTS.md) - SKILL.md: Condense from 682 to 225 lines (67% reduction) - Keep procedural knowledge (package creation, Python scripts) - Add "How mt Works" section (function vs binary) - Replace detailed docs with references to docs/ files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <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
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
docs/conventions/documentation/directory with progressive disclosure structureChanges
Created 7 new files in
docs/conventions/documentation/:Updated:
docs/conventions/README.md: Link to new documentation directorySKILL.md: Reference new documentation structureDeleted:
docs/conventions/documentation.md(content migrated)docs/conventions/documentation-organization.md(content migrated)Key Decisions
Two documentation approaches:
AGENTS.md is the industry standard for AI coding assistants (60k+ repos)
docs/commands/ directory pattern for package command reference
Test plan
🤖 Generated with Claude Code