Skip to content

Commit

Permalink
removed mention of the indy-docs-conf. That repository will become de…
Browse files Browse the repository at this point in the history
…precated as the remote_conf file has been moved to the indy-docs repository

Signed-off-by: michael <michael.boyd@sovrin.org>
  • Loading branch information
michaeldboyd committed Dec 8, 2018
1 parent 00fe172 commit aec62e9
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions text/0025-indy-docs-framework/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,8 @@ Here is a list of all the repositories in which we have documentation:

In addition, we have created the indy-docs repository to hold general prose that explains indy concepts and provides users a jumping off point into the respective repos.
- indy-docs: https://github.com/michaeldboyd/indy-docs/
We've also create a shared configuration file meant purely for readthedocs to build our shared docs site.
- indy-docs-conf: https://github.com/michaeldboyd/indy-docs-conf/
Provided this HIPE is accepted, we should official HL/indy-docs and HL/indy-docs-conf repositories. See the [multiproject sidebar](#sidebar) section for more information on why this is needed.

Provided this HIPE is accepted, we should create an official HL/indy-docs repository to maintain these general conceptual documents. This can probably replace the [hyperledger-indy wiki page](https://wiki.hyperledger.org/projects/indy).

### Implementation Details
Each Indy project has a `docs/` directory at the project root. This directory contains all of the documentation that is relevant to the repository. The docs/source directory contains all of the documentation that will be built into the html library. Here is the indy-sdk `docs/` directory as an example: https://github.com/michaeldboyd/indy-sdk/blob/sphinx-docs-test/docs
Expand Down

0 comments on commit aec62e9

Please sign in to comment.