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

Publish the API documentation #254

Open
javagl opened this issue Dec 15, 2022 · 0 comments
Open

Publish the API documentation #254

javagl opened this issue Dec 15, 2022 · 0 comments

Comments

@javagl
Copy link
Contributor

javagl commented Dec 15, 2022

The API documentation of the validator should be hosted at a public place.

Right now, the documentation can be built via npm run docs. The result is stored as a bunch of interlinked Markdown files in the build/docs folder. But they should eventually be hosted at a public place. Where and how this will be done has to be decided.


Note: The current release version of the validator is a 0.x.y version, tagged as "beta", for early previews and feedback. The API surface is intentionally kept minimal for now, as more precise requirements for the use case as a libarary are gathered.

@javagl javagl mentioned this issue Dec 15, 2022
53 tasks
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