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

Incorperate Readme into Docs #129

Open
oxinabox opened this issue May 17, 2024 · 0 comments
Open

Incorperate Readme into Docs #129

oxinabox opened this issue May 17, 2024 · 0 comments

Comments

@oxinabox
Copy link
Member

oxinabox commented May 17, 2024

The readme is great and contains lost of useful information about how to use the package.
I think we should just run cp(joinpath("dirname(@__DIR__)/README.md"), joinpath(@__DIR__, "src", "index.md"))
in the docs/make.jl
and move the current index.md to be called "API Reference" or similar.

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

No branches or pull requests

1 participant