openwallet-foundation / acapy

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments.
https://wiki.hyperledger.org/display/aries
Apache License 2.0
412 stars 512 forks source link

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

Closed swcurran closed 1 year ago

swcurran commented 2 years ago

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.

TimoGlastra commented 2 years ago

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

swcurran commented 1 year ago

@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.

esune commented 1 year ago

I think this is resolved by #2079

amanji commented 1 year ago

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

swcurran commented 1 year ago

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!