neo4j.cr icon indicating copy to clipboard operation
neo4j.cr copied to clipboard

Add API docs

Open jgaskins opened this issue 3 years ago • 0 comments

Use GitHub pages for this and generate the docs with this command:

crystal docs --project-version=$VERSION --source-refname=v$VERSION

A script should probably be written to run that that, which would require a version to be supplied. Ideally, it would work the way the Crystal folks support multiple versions in their API docs with a dropdown (see image below), but I don't know how they do that. The retroactive documentation can be added later, though.

Screenshot of the dropdown from the Crystal language API docs, showing the nightly build on top followed by every released version back to 1.3.0, with more continuing below the bottom edge of the screenshot

I'll have to enable GHP on this repo, as well, which will host it at https://jgaskins.dev/neo4j.cr

jgaskins avatar Jul 31 '22 17:07 jgaskins