Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API reference: code demos from source jsdoc #115

Open
jonathanolson opened this issue Jan 28, 2025 · 0 comments
Open

API reference: code demos from source jsdoc #115

jonathanolson opened this issue Jan 28, 2025 · 0 comments
Assignees
@jonathanolson
Labels
documentation Improvements or additions to documentation priority:3-medium

Comments

@jonathanolson
Copy link
Contributor

We have a lot of options or examples that would better live IN the source code, and more importantly in the api reference location instead of guides.

Similarly to BinPacker and ConvexHull for the dot documentation, we should allow inline JS/TS examples, using the sandbox.
@jonathanolson jonathanolson added documentation Improvements or additions to documentation priority:3-medium labels Jan 28, 2025
@jonathanolson jonathanolson self-assigned this Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonathanolson jonathanolson

Labels
documentation Improvements or additions to documentation priority:3-medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jonathanolson