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.

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

add docs #13

Merged
merged 2 commits into from
Oct 23, 2023
Merged

add docs #13

merged 2 commits into from
Oct 23, 2023

Conversation

baggepinnen
Copy link
Contributor

This PR adds the example from the readme with some additional explanations, as well as a page with exported interface.
Tutorials will come in a second PR

@baggepinnen
Copy link
Contributor Author

I don't have permissions to change settings for this repo, but I believe we need to enable github pages and set up the Documenter key etc. for the docs to publish correctly.

@topolarity topolarity added this to the Public MVP milestone Oct 23, 2023
Copy link
Member

@topolarity topolarity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution!

One step closer to public MVP

@topolarity topolarity merged commit 6dadae5 into main Oct 23, 2023
3 of 4 checks passed
@delete-merged-branch delete-merged-branch bot deleted the fb/docs branch October 23, 2023 16:29
@topolarity
Copy link
Member

Live (publically) at https://juliacomputing.github.io/AllocCheck.jl/

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.

2 participants