Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
* Change links http -> https
* Fix formatting in Additional Instructions section
  • Loading branch information
voutasaurus authored Aug 28, 2019
1 parent 641327b commit c136909
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Documentation README
Check out the docs at http://hyperledger-indy.readthedocs.io/projects/sdk
Check out the docs at https://hyperledger-indy.readthedocs.io/projects/sdk

Learn more about how our docs are built and maintained at http://hyperledger-indy.readthedocs.io/en/latest/docs.html
Learn more about how our docs are built and maintained at https://hyperledger-indy.readthedocs.io/en/latest/docs.html

This `docs/` directory should contain all of the documents associated with the repository, with the exception of README files that describe technical details with the directories of code.

Expand Down Expand Up @@ -47,8 +47,9 @@ make html
This will generate all the html files in `docs/_build/html` which you can then browse locally in your browser. Every time you make a change to the documentation you will need to rerun `make html`.

## Additional Instructions
This section is to be used for repo maintainers to add additional documentation guidelines or instructions.
This section is to be used for repo maintainers to add additional documentation guidelines or instructions.

**TODO: Build the respective code API's into the readthedocs website**

**TODO: Add table support for markdown files**
* This link may help: https://github.com/ryanfox/sphinx-markdown-tables
* This link may help: https://github.com/ryanfox/sphinx-markdown-tables

0 comments on commit c136909

Please sign in to comment.