Move documentation to wiki
Separate from this CL, I copied documentation from the README file and
About page to gddo's GitHub wiki.
This change removes the documentation from the README file and About
page. This change also adds a wiki link to these pages.
Fixes #248.
diff --git a/README.markdown b/README.markdown
index 063f19d..6f95b01 100644
--- a/README.markdown
+++ b/README.markdown
@@ -19,101 +19,7 @@
need you to fill out a short form before we can accept your contribution:
https://developers.google.com/open-source/cla/individual
-Development Environment Setup
------------------------------
+More Documentation
+------------------
-- Install and run [Redis 2.8.x](http://redis.io/download). The redis.conf file included in the Redis distribution is suitable for development.
-- Install Go 1.4.
-- Install and run the server:
-
- $ go get github.com/golang/gddo/gddo-server
- $ gddo-server
-
-- Browse to [http://localhost:8080/](http://localhost:8080/)
-- Enter an import path to have the server retrieve & display a package's documentation
-
-Optional:
-
-- Create the file gddo-server/config.go using the template in [gddo-server/config.go.template](gddo-server/config.go.template).
-
-API
----
-
-The GoDoc API is comprised of these endpoints:
-
-**api.godoc.org/search?q=`Query`**—Returns search results for Query, in JSON format.
-
-```json
-{
- "results": [
- {
- "path": "import/path/one",
- "synopsis": "Package synopsis is here, if present."
- },
- {
- "path": "import/path/two",
- "synopsis": "Package synopsis is here, if present."
- }
- ]
-}
-```
-
-**api.godoc.org/packages**—Returns all indexed packages, in JSON format.
-
-```json
-{
- "results": [
- {
- "path": "import/path/one"
- },
- {
- "path": "import/path/two"
- },
- {
- "path": "import/path/three"
- }
- ]
-}
-```
-
-**api.godoc.org/importers/`ImportPath`**—Returns packages that import ImportPath, in JSON format. Not recursive, direct imports only.
-
-```json
-{
- "results": [
- {
- "path": "import/path/one",
- "synopsis": "Package synopsis is here, if present."
- },
- {
- "path": "import/path/two",
- "synopsis": "Package synopsis is here, if present."
- }
- ]
-}
-```
-
-**api.godoc.org/imports/`ImportPath`**—Returns packages that ImportPath imports, in JSON format. Not recursive, direct imports only.
-
-```json
-{
- "imports": [
- {
- "path": "import/path/one",
- "synopsis": "Package synopsis is here, if present."
- },
- {
- "path": "import/path/two",
- "synopsis": "Package synopsis is here, if present."
- }
- ],
- "testImports": [
- {
- "path": "import/path/three",
- "synopsis": "Package synopsis is here, if present."
- }
- ]
-}
-```
-
-A plain text interface is documented at <http://godoc.org/-/about>.
+More documentation about this project is available on the [wiki](https://github.com/golang/gddo/wiki).
diff --git a/gddo-server/assets/templates/about.html b/gddo-server/assets/templates/about.html
index fd15cb8..96c5283 100644
--- a/gddo-server/assets/templates/about.html
+++ b/gddo-server/assets/templates/about.html
@@ -53,17 +53,6 @@
<p>Send your ideas, feature requests and questions to the <a href="https://groups.google.com/group/golang-dev">golang-dev mailing list</a>.
Report bugs using the <a href="https://github.com/golang/gddo/issues/new">GitHub Issue Tracker</a>.
-<h4 id="plain-text">Plain Text</h4>
-
-GoDoc provides plain text output for integration with shell scripts. Use the
-HTTP Accept header to request a plain text response.
-
-<p>Search for packages with the term 'sql':
-<pre>$ curl -H 'Accept: text/plain' http://godoc.org/?q=sql</pre>
-
-<p>Get the documentation for the standard math package:
-<pre>$ curl -H 'Accept: text/plain' http://godoc.org/math</pre>
-
<h4 id="shortcuts">Keyboard Shortcuts</h4>
<p>GoDoc has keyboard shortcuts for navigating package documentation
@@ -76,4 +65,8 @@
bookmarklet, click and drag the following link to your bookmark bar: <a
href="javascript:window.location='http://{{.Host}}/?q='+encodeURIComponent(window.location)">GoDoc</a>
+<h4>More Documentation</h4>
+
+<p>More documentation about GoDoc is available on <a href="https://github.com/golang/gddo/wiki">the project's GitHub wiki</a>.
+
{{end}}
