Back to list
CheekyCodexConjurer

sync-documentation

by CheekyCodexConjurer

AERA: local-first workstation for quantitative research, visualization, and backtesting.

0🍴 0📅 Jan 6, 2026

SKILL.md


name: Sync Documentation description: Use this skill at the end of a task to ensure documentation matches the code.

Sync Documentation

Use this skill to prevent documentation drift after you change behavior, flows, or structure.

Checklist

  1. architecture.md (index)
  • New module/service/folder? -> add it to the index
  • Changed a main flow? -> update the relevant docs/architecture/* page(s)
  1. docs/architecture/ (leaf docs)
  • Update the page(s) that map to the modified area (backend core/data/indicators, chart map, flows, runs/logging, etc.)
  • Keep each doc short and linkable (LLM-friendly)
  1. README.md
  • New env var? -> document it
  • Changed how to run/test? -> update commands
  1. ROADMAP.md
  • Completed an item? -> mark it done
  • New work discovered? -> add it

Output requirement

In the final response, explicitly list:

  • Updated: architecture.md (if changed)
  • Updated: docs/architecture/... (if changed)
  • Updated: README.md / Updated: ROADMAP.md (if changed)

Score

Total Score

55/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新

+5
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon