From c5263d2388d1ad903b63130445d29d30b10075ed Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Thu, 21 Mar 2024 08:58:20 -0700 Subject: [PATCH] Minor updates to the documentation - links, navigation and markdown Signed-off-by: Stephen Curran --- CHANGELOG.md | 2 +- README.md | 4 +++- docs/demo/ReusingAConnection.md | 10 +++++----- docs/features/AnonCredsMethods.md | 2 +- mkdocs.yml | 1 + 5 files changed, 11 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89623d92ca..509c65530f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1306,7 +1306,7 @@ release and later, and "as-is" connections made using earlier releases of ACA-Py candidates. A new "Upgrade deployment" capability ([#1557](https://github.com/hyperledger/aries-cloudagent-python/pull/1557), described below) must be executed to update your deployment to add tags for all existing connections. -The [Supported RFCs document](/SupportedRFCs.md) has been updated to reflect the addition of the +The [Supported RFCs document](docs/features/SupportedRFCs.md) has been updated to reflect the addition of the AIP 2.0 RFCs for which support was added. The following is an annotated list of PRs in the release, including a link to each PR. diff --git a/README.md b/README.md index cbaa310f74..bba261ed60 100644 --- a/README.md +++ b/README.md @@ -80,10 +80,12 @@ in the [Aries ACA-Py Plugins repository]. Check them out -- it might have the ve ### Installation and Usage -Use the ["install and go" page for developers](docs/features/DevReadMe.md) if you are comfortable with Trust over IP and Aries concepts. ACA-Py can be run with Docker without installation (highly recommended), or can be installed [from PyPi](https://pypi.org/project/aries-cloudagent/). In the [/demo directory](./demo) there is a full set of demos for developers to use in getting started, and the [demo read me](docs/demo/README.md) is a great starting point for developers to use an "in-browser" approach to run a zero-install example. The [Read the Docs](https://aries-cloud-agent-python.readthedocs.io/en/latest/) overview is also a way to understand the internal modules and APIs that make up an ACA-Py instance. +Use the ["install and go" page for developers](docs/features/DevReadMe.md) if you are comfortable with Trust over IP and Aries concepts. ACA-Py can be run with Docker without installation (highly recommended), or can be installed [from PyPi](https://pypi.org/project/aries-cloudagent/). In the repository `/demo` folder there is a full set of demos for developers to use in getting up to speed quickly. Start with the [Traction Workshop] to go through a complete ACA-Py-based Issuer-Holder-Verifier flow in about 20 minutes. Next, the [Alice-Faber Demo](docs/demo/README.md) is a great way for developers try a zero-install example of how to use the ACA-Py API to operate a couple of Aries Agents. The [Read the Docs](https://aries-cloud-agent-python.readthedocs.io/en/latest/) overview is also a way to understand the internal modules and APIs that make up an ACA-Py instance. If you would like to develop on ACA-Py locally note that we use Poetry for dependency management and packaging, if you are unfamiliar with poetry please see our [cheat sheet](docs/deploying/Poetry.md) +[Traction Workshop]: docs/demo/Aries-Workshop.md + ## About the ACA-Py Admin API The [overview of ACA-Py’s API](docs/features/AdminAPI.md) is a great starting place for learning about the ACA-Py API when you are starting to build your own controller. diff --git a/docs/demo/ReusingAConnection.md b/docs/demo/ReusingAConnection.md index 1a4f8ee7e8..2c7e94dfd6 100644 --- a/docs/demo/ReusingAConnection.md +++ b/docs/demo/ReusingAConnection.md @@ -92,12 +92,12 @@ Example invitation: } ``` -The use of conenction reuse can be demonstrated with the Alice / Faber demos as +The use of connection reuse can be demonstrated with the Alice / Faber demos as follows. We assume you have already somewhat familiar with your options for running the [Alice Faber Demo] (e.g. locally or in a browser). Follow those instruction up to the point where you are about to start the Faber and Alice agents. -[Alice Faber Demo]: ./README.md +[Alice Faber Demo]: ../demo/README.md 1. On a command line, run Faber with these parameters: `./run_demo faber --reuse-connections --public-did-connections --events`. @@ -130,18 +130,18 @@ always the same that tells the invitee that they can reuse an existing connectio For example, to run faber with connection reuse using a non-public DID: -``` +``` bash ./run_demo faber --reuse-connections --events ``` To run faber using a `did_peer` and reusable connections: -``` +``` bash DEMO_EXTRA_AGENT_ARGS="[\"--emit-did-peer-2\"]" ./run_demo faber --reuse-connections --events ``` To run this demo using a multi-use invitation (from Faber): -``` +``` bash DEMO_EXTRA_AGENT_ARGS="[\"--emit-did-peer-2\"]" ./run_demo faber --reuse-connections --multi-use-invitations --events ``` diff --git a/docs/features/AnonCredsMethods.md b/docs/features/AnonCredsMethods.md index 7b04faa6e7..882faf0f65 100644 --- a/docs/features/AnonCredsMethods.md +++ b/docs/features/AnonCredsMethods.md @@ -31,7 +31,7 @@ in the [aries-acapy-plugins] repository. If you think that the AnonCreds method be part of ACA-Py core, get your plugin complete and raise the question of adding it to ACA-Py. The Maintainers will be happy to discuss the merits of the idea. No promises though. -[ACA-Py plugins]: ../Plugins.md +[ACA-Py plugins]: ./PlugIns.md [aries-acapy-plugins]: https://github.com/hyperledger/aries-acapy-plugins Your AnonCreds plugin will have an [initialization routine] that will register your AnonCreds diff --git a/mkdocs.yml b/mkdocs.yml index edbee1219d..00ffcf2280 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -109,6 +109,7 @@ nav: - Using W3C JSON-LD Credentials: demo/AliceWantsAJsonCredential.md - DIY -- ACME Controller Workshop: demo/AcmeDemoWorkshop.md - Aries Using Postman Demo: demo/AriesPostmanDemo.md + - Reusing a Connection Between Agents: demo/ReusingAConnection.md - Getting Started: - Becoming an Indy/Aries Developer: gettingStarted/README.md - Hyperledger Indy Basics: gettingStarted/IndyBasics.md