Page MenuHomePhabricator
Files F15380792

D20086.id47972.diff
No OneTemporary
Actions

D20086.id47972.diff
View Options

diff --git a/src/docs/user/userguide/diviner.diviner b/src/docs/user/userguide/diviner.diviner
--- a/src/docs/user/userguide/diviner.diviner
+++ b/src/docs/user/userguide/diviner.diviner
@@ -3,17 +3,28 @@
Using Diviner, a documentation generator.
-= Overview =
+Overview
+========
-NOTE: Diviner is new and not yet generally useful.
+Diviner is an application for creating technical documentation.
-= Generating Documentation =
+This article is maintained in a text file in the Phabricator repository and
+generated into the display document you are currently reading using Diviner.
+
+Beyond generating articles, Diviner can also analyize source code and generate
+documentation about classes, methods, and other primitives.
+
+
+Generating Documentation
+========================
To generate documentation, run:
phabricator/ $ ./bin/diviner generate --book <book>
-= .book Files =
+
+Diviner ".book" Files
+=====================
Diviner documentation books are configured using JSON `.book` files, which
look like this:

File Metadata

Mime Type
text/plain
Expires
Sat, Mar 15, 4:27 AM (2 w, 7 h ago)
Storage Engine
blob
Storage Format
Encrypted (AES-256-CBC)
Storage Handle
7683116
Default Alt Text
D20086.id47972.diff (1 KB)

Event Timeline

Phabricator · Built by Phacility