Add API.md with full API reference and Mermaid diagrams#1
Open
Copilot wants to merge 2 commits into
Open
Conversation
…grams Co-authored-by: caggionim <62551539+caggionim@users.noreply.github.com> Agent-Logs-Url: https://github.com/rheopy/rheofit/sessions/4bb97a8a-8231-4396-8eae-de2fa5d6d41d
Copilot
AI
changed the title
[WIP] Add API documentation using mermaid diagrams
Add API.md with full API reference and Mermaid diagrams
Mar 25, 2026
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
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.
No structured API reference existed — only a README and Jupyter notebooks. This adds
API.mdas a dedicated, scannable API doc.Contents
5 Mermaid diagrams
graph TD— package/module structureflowchart LR— typical fit workflow (load → choose model → fit → visualise → export)classDiagram— model taxonomy (NoYieldStress / YieldStress / Composite)sequenceDiagram—make_par_widgetbranching logic (pre-fit vs defaults)graph LR— runtime dependency mapModel reference for all 15 models: LaTeX equation, parameter table (name, default, min, max, unit)
Function reference for all public callables across
rheofit.models,rheofit.rheodata, andrheofit.visualization, with signatures, parameter tables, and short usage snippetsQuick example (from the doc)
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.