We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Currently the holochain-client-js has great generated documentation, but its just sitting in the repo as markdown files, which makes it hard to use and navigate (https://github.com/holochain/holochain-client-js/tree/develop/docs)
We can use these markdown files on a github pages or docosaurus site to make them much more accessible. See https://api-extractor.com/pages/setup/generating_docs/#using-api-documenter-to-generate-markdown
Or we could use them in a section of the main holochain docs https://github.com/holochain/docs-pages
@jost-s
The text was updated successfully, but these errors were encountered:
Yeah, I like the ideas.
I agree that the link of the docs that you posted is confusing. However, on the JS client repo site, the "Complete API reference" link takes you here https://github.com/holochain/holochain-client-js/blob/develop/docs/client.md
How do you find that for navigating?
Other than that, Docusaurus seems like the better option to me.
Sorry, something went wrong.
oh yeah -- that's definitely better -- I'll try to put together a docosaurus version and see how it looks
No branches or pull requests
Currently the holochain-client-js has great generated documentation, but its just sitting in the repo as markdown files, which makes it hard to use and navigate (https://github.com/holochain/holochain-client-js/tree/develop/docs)
We can use these markdown files on a github pages or docosaurus site to make them much more accessible. See https://api-extractor.com/pages/setup/generating_docs/#using-api-documenter-to-generate-markdown
Or we could use them in a section of the main holochain docs https://github.com/holochain/docs-pages
@jost-s
The text was updated successfully, but these errors were encountered: