← Back to list

markdowntown-docs
by joelklabo
markdowntown scan CLI
⭐ 0🍴 0📅 Jan 19, 2026
SKILL.md
name: markdowntown-docs description: Use this when writing or updating docs/ content, UX specs, or cross-linking guides in markdowntown.
Docs + content updates
When to use
- Editing or adding docs under
docs/. - Aligning terminology across UX, architecture, and product guides.
- Updating user-facing flow documentation.
Workflow
-
Pick the right home
- UX flow or copy guidance →
docs/ux. - Visual/UI guidance →
docs/designordocs/ui. - Technical system notes →
docs/architecture. - User-facing walkthroughs →
docs/USER_GUIDE.md.
- UX flow or copy guidance →
-
Keep terminology consistent
- Use “Scan”, “Workbench”, “Library”, “Translate”, “Docs”.
- Distinguish AGENTS.md (repo file) vs agents.md (export output).
-
Cross-linking
- Link related docs when a flow spans multiple surfaces (e.g., UX → Architecture).
- Avoid duplicating long explanations; point to canonical docs.
-
Editing checklist
- Maintain concise headings, short paragraphs, and action-oriented language.
- Update any references, diagrams, or CTA text if UI changed.
References
- codex/skills/markdowntown-docs/references/docs-map.md
- codex/skills/markdowntown-docs/references/content-style.md
Guardrails
- Keep SKILL.md concise; move long detail to references.
- Always log follow-up tasks for gaps you notice.
Score
Total Score
60/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon