docs: restructure documentation for clarity #30
Merged
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #30 +/- ##
=======================================
Coverage ? 90.96%
=======================================
Files ? 22
Lines ? 1936
Branches ? 0
=======================================
Hits ? 1761
Misses ? 175
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Compact README.md with inline end-user guide - Add DEVELOPMENT.md for human developers - Delete skill/README.md (violates Agent Skills spec) - Delete obsolete development history files - Maintain AGENTS.md for AI agents (no changes needed) Changes: - README.md now includes installation guide for Claude.ai/Codex users - skill/ directory follows Agent Skills specification (SKILL.md only) - Clear entry points for all stakeholders: - End users: README.md (with installation/FAQ) - Developers: DEVELOPMENT.md - AI agents: AGENTS.md Fixes issue where skill/README.md violated agentskills.io specification which states skill directory should only contain SKILL.md + optional scripts/references/assets directories. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
unagi
force-pushed
the
docs/restructure-documentation
branch
from
eb8f823 to
477dfb3
Compare
|
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
プロジェクトドキュメントの包括的な再構成により、すべてのステークホルダーに最適な情報提供を実現しました。
Changes
新規作成
変更
削除
skill/配下はSKILL.md+ オプショナルなscripts/,references/,assets/のみ許可skill/配下はLLM経由でのみアクセスされる維持
Motivation
問題点
解決策
Impact
🤖 Generated with Claude Code