Link to docs (gomods#440)

* Add link to our new docs site at the top of the readme * Update links to use docs site, not raw markdown
jpreese · Aug 10, 2018 · e0a983e · e0a983e
1 parent e44782f
commit e0a983e
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 294 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -55,8 +55,8 @@ Note that `make dev` only runs the minimum amount of dependencies needed for thi
 As you know from reading the [README](./README.md) (if you didn't read the whole thing, that's ok. Just read the
 introduction), the Athens project is made up of two components:
 
-1. [Package Registry](./REGISTRY.md)
-2. [Edge Proxy](./PROXY.md)
+1. [Package Registry](https://docs.gomods.io/design/registry/)
+2. [Edge Proxy](https://docs.gomods.io/design/proxy/)
 
 To run the registry:
 

diff --git a/PROXY.md b/PROXY.md
diff --git a/README.md b/README.md
@@ -2,12 +2,12 @@
 
 # Welcome Gophers!
 
-Welcome to the Athens project! We're building all things Go package repository in here. 
+Welcome to the Athens project! We're building all things Go package repository in here.
 
-1. [Package Registry](./REGISTRY.md)
-2. [Edge Proxy](./PROXY.md)
+1. [Package Registry](https://docs.gomods.io/design/registry/)
+2. [Edge Proxy](https://docs.gomods.io/design/proxy/)
 
-If you want more of a tl;dr on the project, check out [this quick introduction](https://medium.com/@arschles/project-athens-c80606497ce1)
+See our documentation site [https://docs.gomods.io](https://docs.gomods.io) for more details on the project.
 
 # Project Status
 
@@ -29,7 +29,7 @@ Although the project is in development, here's where we're going:
 The package registry and the edge proxy both implement the [vgo download protocol](https://medium.com/@arschles/project-athens-the-download-protocol-2b346926a818), but each one
 is intended for different purposes.
 
-The registry will be hosted globally, and will be "always on" for folks. Anyone will be able to 
+The registry will be hosted globally, and will be "always on" for folks. Anyone will be able to
 configure their machine to do a `go get` (right now, it's a `vgo get`) and have it request
 packages from the registry.
 
@@ -67,14 +67,14 @@ If you're not ready to contribute code yet, there are plenty of other great ways
 - Get familiar with the system. There's lots to read about. Here are some places to start:
     - [Gentle Introduction to the Project](https://medium.com/@arschles/project-athens-c80606497ce1) - the basics of why we started this project
     - [The Download Protocol](https://medium.com/@arschles/project-athens-the-download-protocol-2b346926a818) - the core API that the registry and proxies implement and CLIs use to download packages
-    - [Registry Design](./REGISTRY.md) - what the registry is and how it works
-    - [Proxy Design](./PROXY.md) - what the proxy is and how it works
+    - [Registry Design](https://docs.gomods.io/design/registry/) - what the registry is and how it works
+    - [Proxy Design](https://docs.gomods.io/design/proxy/) - what the proxy is and how it works
     - [vgo wiki](https://github.com/golang/go/wiki/vgo) - context and details on how Go dependency management works in general
     - ["Go and Versioning"](https://research.swtch.com/vgo) - long papers on Go dependency management details, internals, etc...
 
 # Built on the Shoulders of Giants
 
-The Athens project would not be possible without the amazing projects it builds on. Please see 
+The Athens project would not be possible without the amazing projects it builds on. Please see
 [SHOULDERS.md](./SHOULDERS.md) to see a list of them.
 
 # Coding Guidlines

diff --git a/REGISTRY.md b/REGISTRY.md
diff --git a/docs/content/design/proxy.md b/docs/content/design/proxy.md
@@ -5,7 +5,7 @@ date: 2018-02-11T15:59:56-05:00
 
 ## The Athens Proxy
 
-The Athens project has two components, the [central registry](./REGISTRY.md) and edge proxies.
+The Athens project has two components, the [central registry](/design/registry/) and edge proxies.
 This document details the latter.
 
 ## The Role of the Proxy
@@ -70,4 +70,4 @@ Private module filters are string globs that tell the proxy what is a private mo
 
 ### Exclude Lists for Public Modules
 
-Exclude lists for public modules are also globs that tell the proxy what modules it should never download from the registry. For example, the string `github.com/arschles/**` tells the proxy to always return `404 Not Found` to clients.
+Exclude lists for public modules are also globs that tell the proxy what modules it should never download from the registry. For example, the string `github.com/arschles/**` tells the proxy to always return `404 Not Found` to clients.