Skip to content

Document the public API with one table and two figures - #41

Open
almogtavor wants to merge 7 commits into
mainfrom
api-overview
Open

almogtavor wants to merge 7 commits into
mainfrom
api-overview

Conversation

@almogtavor

@almogtavor almogtavor commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Documentation only. docs/api.md now opens with a short overview: a table of the five names afdep exports and a figure of the four Buffer calls of one exchange, with the role that makes each call and what it returns. A second figure replaces the sentence that listed the call order with two lanes. docs/assets/plot_api.py draws both figures, in a light and a dark version.

The docs site now also serves docs/assets under /docs/assets, so the relative image links of the Markdown pages resolve there as they do on GitHub. This also brings back the two figures of the sparse hybrid page on the site.

The contract text is unchanged, except for one sentence in "Transport and tuning" that repeated the overview.

@almogtavor
almogtavor requested a review from Etelis as a code owner November 17, 2026 13:42
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.2

QR code for preview link

🚀 View preview at
https://afdEP.github.io/afdEP-comm/pr-preview/pr-41/

Built to branch gh-pages at 2026-11-17 18:07 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

The call table and the lane order sentence become two figures drawn by
docs/assets/plot_api.py. The docs site now also serves docs/assets under
/docs/assets, so the relative image links of the Markdown pages resolve
there as they do on GitHub.
@almogtavor almogtavor changed the title Document the public API in one table Document the public API with one table and two figures Nov 17, 2026
@almogtavor

Copy link
Copy Markdown
Member Author

CC @ronenkat

This branch has not been deployed

No deployments
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