From bf3be2ef1fd0c374db32b634242eb9bc2ab43a3c Mon Sep 17 00:00:00 2001 From: Rob Szumski Date: Wed, 24 Aug 2016 10:25:32 -0700 Subject: [PATCH 1/2] readme: add link to docs dir --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f3c0932..7e7561d6 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,10 @@ $ ./$GOBIN/clair -config=config.yaml ## Documentation -The latest stable documentation can be found [on the CoreOS website] or inside the Documentation directory at the root of the project's source code. +The latest stable documentation can be found [on the CoreOS website] or [inside the Documentation directory][docs-dir] at the root of the project's source code. [on the CoreOS website]: https://coreos.com/clair/docs/latest/ +[docs-dir]: /Documentation ### Architecture at a Glance From f0f69bb7ad93d6fbca5b4c119779c23c8409fc50 Mon Sep 17 00:00:00 2001 From: Rob Szumski Date: Wed, 24 Aug 2016 10:56:06 -0700 Subject: [PATCH 2/2] readme: clarify docs on github --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e7561d6..22199e1d 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ $ ./$GOBIN/clair -config=config.yaml ## Documentation -The latest stable documentation can be found [on the CoreOS website] or [inside the Documentation directory][docs-dir] at the root of the project's source code. +The latest stable documentation can be found [on the CoreOS website]. Documentation for the current branch can be found [inside the Documentation directory][docs-dir] at the root of the project's source code. [on the CoreOS website]: https://coreos.com/clair/docs/latest/ [docs-dir]: /Documentation