From eb6117c372dc235f3501faa20ee64c4961abf59a Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Wed, 24 Aug 2016 12:11:15 -0400 Subject: [PATCH] Merge pull request #235 from jzelinskie/doc-move docs: move to standard Documentation dir --- api/v1/README.md => Documentation/api_v1.md | 0 notifier/README.md => Documentation/notifications.md | 0 README.md | 5 ++--- 3 files changed, 2 insertions(+), 3 deletions(-) rename api/v1/README.md => Documentation/api_v1.md (100%) rename notifier/README.md => Documentation/notifications.md (100%) diff --git a/api/v1/README.md b/Documentation/api_v1.md similarity index 100% rename from api/v1/README.md rename to Documentation/api_v1.md diff --git a/notifier/README.md b/Documentation/notifications.md similarity index 100% rename from notifier/README.md rename to Documentation/notifications.md diff --git a/README.md b/README.md index b64e9095..d298dae1 100644 --- a/README.md +++ b/README.md @@ -126,10 +126,9 @@ While container images for every releases are available at [quay.io/repository/c ## Documentation -Documentation can be found in a `README.md` file located in the directory of the component. +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. -- [Notifier](https://github.com/coreos/clair/blob/master/notifier/README.md) -- [v1 API](https://github.com/coreos/clair/blob/master/api/v1/README.md) +[on the CoreOS website]: https://coreos.com/clair/docs/latest/ ### Architecture at a Glance