Merge pull request #2771 from swcurran/tweaks-for-docs-publishing

Tweaks to MD files to enable aca-py.org publishing

README.md

@@ -80,7 +80,7 @@ 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 [/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.
 
 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)
 
@@ -114,11 +114,11 @@ The initial implementation of ACA-Py was developed by the Government of British
 See the [MAINTAINERS.md](./MAINTAINERS.md) file for a list of the current ACA-Py
 maintainers, and the guidelines for becoming a Maintainer. We'd love to have you
 join the team if you are willing and able to carry out the [duties of a
-Maintainer](MAINTAINERS.md#the-duties-of-a-maintainer).
+Maintainer](./MAINTAINERS.md#the-duties-of-a-maintainer).
 
 ## Contributing
 
-Pull requests are welcome! Please read our [contributions guide](CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing — [guidance](https://github.com/apps/dco) on this is available. We also welcome issues submitted about problems you encounter in using ACA-Py.
+Pull requests are welcome! Please read our [contributions guide](./CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing — [guidance](https://github.com/apps/dco) on this is available. We also welcome issues submitted about problems you encounter in using ACA-Py.
 
 ## License
 

docs/UpdateRTD.md

@@ -38,7 +38,7 @@ Once generated, go into the `_build` folder and open `index.html` in a browser.
 This is the hard part; looking for errors in docstrings added by devs. Some tips:
 
 - missing imports (`No module named 'async_timeout'`) can be solved by adding the module to the
-list of `autodoc_mock_imports` in the [conf.py](./conf.py) file.
+list of `autodoc_mock_imports` in the `conf.py` file in the ACA-Py `docs` folder.
 - Ignore any errors in .md files
 - Ignore the warnings about including `docs/README.md`
 - Ignore an dist-package errors
@@ -48,7 +48,7 @@ to adhere to the rules around processing docstrings, and especially around JSON
 
 ### Checking for missing modules
 
-The file [`index.rst`](index.rst) in this folder drive the RTD generation. It should pick up all the modules
+The file `index.rst` in the ACA-Py `docs` folder drive the RTD generation. It picks up all the modules
 in the source code, starting from the root `../aries_cloudagent` folder. However, some modules
 are not picked up automatically from the root and have to be manually added to `index.rst`. To do that:
 

docs/demo/AriesPostmanDemo.md

@@ -32,7 +32,7 @@ Create a new postman workspace labeled "acapy-demo".
 
 ### Importing the environment
 
-In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) or copy the json from the [environment file](./postman/environment.json).
+In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) which is the [environment file](https://github.com/hyperledger/aries-cloudagent-python/blob/main/demo/postman/environment.json) in the ACA-Py repository.
 
 Make sure you have the environment set as your active environment.