Commit graph

1 commit

Author SHA1 Message Date
Nabin Mulepati
5b9492e6cf
docs: restructure agent and contributor documentation (plan 427, PR 1) (#454)
* docs: restructure agent and contributor documentation

Restructure AGENTS.md from ~627 lines to ~55 lines of high-signal
architectural invariants. Extract code style into STYLEGUIDE.md and
development workflow into DEVELOPMENT.md. Overhaul CONTRIBUTING.md
to reflect agent-assisted development as the primary workflow.

Move skills and sub-agents from .claude/ to .agents/ as the
tool-agnostic home, with symlinks back for Claude Code compatibility.
Add architecture/ skeleton with 10 stub files for incremental
population.

Implements PR 1 of #427.

Made-with: Cursor

* remove obsolete new-sdg skill

The new-sdg skill is superseded by skills/data-designer/, which is the
proper usage skill for building datasets. Update .agents/README.md to
reference the usage skill's actual location.

Made-with: Cursor

* docs: expand style guide and refine development docs

Add docstring conventions (Google style), Pydantic/dataclass guidance,
error handling patterns, and f-string preference to STYLEGUIDE.md.

Clarify per-package test targets, flat test style, e2e API key
requirement, notebook regeneration commands, and import perf threshold
in DEVELOPMENT.md.

Point dataset-building agents to the data-designer skill in AGENTS.md
and clarify dependency direction arrows.

Made-with: Cursor

* docs: link AGENTS.md to architecture/ directory

Made-with: Cursor

* docs: refine CONTRIBUTING.md contribution workflow

Add plan document step, self-review with multi-model passes,
automated CI review expectations, and comment resolution protocol.

Made-with: Cursor

* docs: add architecture/ to PR 2 scope and link from AGENTS.md

Move architecture doc population from deferred/incremental to PR 2
since the subsystems already exist. Update plan delivery strategy,
execution order, and out-of-scope sections accordingly.

Made-with: Cursor

* docs: address PR review comments on style guide, dev guide, and contributing

Replace pd.DataFrame with list[dict[str, str]] in naming example to
avoid contradicting lazy-import guidance in the same file. Soften
"enforced by SIM" to note SIM rules are not yet enabled in CI. Fix
upstream sync instructions for fork-based contributors. Update
copyright year in CONTRIBUTING.md from 2025 to 2026 to match
STYLEGUIDE.md.
2026-03-25 12:38:42 -06:00