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 #2

Closed
lukecarr opened this issue Jan 8, 2023 · 2 comments
Closed

API reference #2

lukecarr opened this issue Jan 8, 2023 · 2 comments
Assignees
@lukecarr
Labels
documentation Improvements or additions to documentation

Comments

@lukecarr
Copy link
Member

lukecarr commented Jan 8, 2023

The documentation site is currently missing an API reference for the mimir crate.

Although most of the API can be pieced together from the contents of the current documentation, we need to have a central API reference that people can refer to.
@lukecarr lukecarr added the documentation Improvements or additions to documentation label Jan 8, 2023
@lukecarr lukecarr self-assigned this Jan 8, 2023
@lukecarr
Copy link
Member Author

lukecarr commented Jan 8, 2023

We should probably just work on adding documentation to the actual source code and let docs.rs take care of the rest (+ add a link to it on our site's navbar).

@lukecarr
Copy link
Member Author

Resolved in v0.5.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lukecarr lukecarr

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lukecarr