Skip to content

Ledgers api index - #11

Merged
Markus-de-Koster merged 7 commits into
mainfrom
ledgers-api-index
Oct 16, 2026
Merged

Markus-de-Koster merged 7 commits into
mainfrom
ledgers-api-index

Conversation

@Markus-de-Koster

Copy link
Copy Markdown
Member
  • Remove claude subagent descriptions
  • added an API Index
  • rewrote CONTEXT.md files
  • removed STATUS.md files (status is now tracked in a separate repo, see below)
  • added a modeling limitations file

Most of the agent instructions are now in a separate repo power-grid-ml/agents

Markus-de-Koster and others added 7 commits October 16, 2026 11:17
Co-Authored-By: Claude Opus 5.5 <[email protected]>
The modeling limitations a user must know move to a docs page under the
modeling section; the internal status file is removed.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…heel

tools/api_index.py writes API_INDEX.md from every public module's __all__
(signature and docstring summary per name). The pixi tasks api-index and
api-index-check regenerate and verify it; CI and the pre-commit hook fail on
a stale index. CONTEXT.md, STATUS.md and API_INDEX.md are excluded from the
wheel and the sdist, and CI checks the built artifacts.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Each CONTEXT.md now states where things live, the conventions and invariants
an edit must preserve, and the decisions it must not undo. Signatures and
parameter semantics live in the docstrings (behaviour previously described
only in the ledgers moved there); derivations moved to the modeling pages.
Stale statements about defaults and converter coverage are corrected.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@Markus-de-Koster
Markus-de-Koster merged commit 09dbca6 into main Oct 16, 2026
8 checks passed
@Markus-de-Koster
Markus-de-Koster deleted the ledgers-api-index branch October 16, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant