aries-cloudagent-python icon indicating copy to clipboard operation
aries-cloudagent-python copied to clipboard

Create a documentation site for the ACA-Py that incorporates and organizes the current Markdown documentation

Open swcurran opened this issue 2 years ago • 1 comments

Create a documentation website for ACA-Py that provides both a useful structure for the documentation, adds introductory material to organize the information for different audiences and incorporates the many existing markdown documents we have in the repo.

swcurran avatar Sep 20 '22 09:09 swcurran

For AFJ we use https://docusaurus.io/, source code can be found here: https://github.com/hyperledger/aries-javascript-docs/

TimoGlastra avatar Sep 21 '22 11:09 TimoGlastra

@amanji has been experimenting with Material for Mkdocs since Hyperledger has the "insider" edition, and Docusaurus, because of the AFJ success with it. Leaning is Docusaurus, perhaps built into ACA-Py repository, or perhaps as a separate site. One of the features we'd like to keep is the generated internal ACA-Py code documentation that we get from Sphinx and ReadTheDocs, but the main focus of the site will be developers getting started with ACA-Py, vs. contributors/maintainers.

swcurran avatar Jan 10 '23 15:01 swcurran

I think this is resolved by #2079

esune avatar Jan 27 '23 00:01 esune

Soon🤞. Need to create a workflow for a multi branch build before that can be merged.

amanji avatar Jan 27 '23 00:01 amanji

First cut of site launched currently at: https://hyperledger.github.io/aries-acapy-docs

I’ll be changing the URL to a custom domain later today, and adding the 0.8.0 docs, then the 0.7.5, and likely the last of the 0.6.X line of docs as well.

I’ll probably do some more maintenance on the docs in main.

Feedback welcome!

swcurran avatar Mar 28 '23 17:03 swcurran