Skip to content

Commit 9b16160

Browse files
authored
Merge pull request #2064 from joshuagl/joshuagl/promo
Make the developer docs and blog more discoverable
2 parents ff6ec11 + f8df202 commit 9b16160

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,15 @@ Documentation
5454
-------------
5555
* [Introduction to TUF's Design](https://theupdateframework.io/overview/)
5656
* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
57-
* [API Reference](https://theupdateframework.readthedocs.io/)
57+
* [Developer documentation](https://theupdateframework.readthedocs.io/), including
58+
[API reference](
59+
https://theupdateframework.readthedocs.io/en/latest/api/api-reference.html)
5860
* [Usage examples](https://github.com/theupdateframework/python-tuf/tree/develop/examples/)
5961
* [Governance](https://github.com/theupdateframework/python-tuf/blob/develop/docs/GOVERNANCE.md)
6062
and [Maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt)
6163
for the reference implementation
6264
* [Miscellaneous Docs](https://github.com/theupdateframework/python-tuf/tree/develop/docs)
65+
* [Python-TUF development blog](https://theupdateframework.github.io/python-tuf/)
6366

6467

6568
Contact

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: "Python-TUF development blog"
33
---
44
This is the development blog for the [Python-TUF](https://github.com/theupdateframework/python-tuf) project, welcome!
5+
If you want to learn how to use Python-TUF, check out our [developer documentation](https://theupdateframework.readthedocs.io/en/latest/).
56

0 commit comments

Comments
 (0)