diff --git a/index.rst b/index.rst index cc8c872..db1e050 100644 --- a/index.rst +++ b/index.rst @@ -8,7 +8,7 @@ Deconst *Deconstruct your Documentation* -`Deconst `_ is a continuous delivery pipeline used to assemble documentation from a heterogenous set of source repositories. Individual GitHub repositories containing content in :abbr:`.rst (reStructuredText)` or :abbr:`.md (Markdown)` formats are **prepared** by being partially rendered to a common JSON format, then mapped to subtrees of the final page by a **control repository**, a plaintext file stored in its own repository. +`Deconst `_ is a continuous delivery pipeline used to assemble documentation from a heterogenous set of source repositories. Individual GitHub repositories containing content in :abbr:`.rst (reStructuredText)` or :abbr:`.md (Markdown)` formats are **prepared** by being partially rendered to a common JSON slurry format, then mapped to subtrees of the final page by a **control repository**, a plaintext file stored in its own repository. This guide serves two purposes: diff --git a/running/architecture.rst b/running/architecture.rst index 1b2f297..ea7871b 100644 --- a/running/architecture.rst +++ b/running/architecture.rst @@ -61,9 +61,9 @@ Terminology Template of common markup that surrounds each presented page with navigation, brand identity, copyright information and anything else that's shared among some subset of each site. - metadata envelope - metadata envelopes - JSON document that contains a single page's worth of content as a rendered HTML fragment, along with + metadata slurry + metadata slurries + JSON slurry that contains a single page's worth of content as a rendered HTML fragment, along with any additional information necessary for the presentation of that page. See :ref:`the schema section ` for a description of the expected structure. @@ -113,7 +113,7 @@ Components Metadata Envelope Schema ------------------------ -Much of the deconst system involves the manipulation of :term:`metadata envelopes`, the JSON documents +Much of the deconst system involves the manipulation of :term:`metadata envelopes`, the JSON slurry produced by each :term:`preparer` that contain the actual content to render. To be presented properly, envelopes must adhere to a common schema. @@ -123,8 +123,7 @@ Here's a `JSON schema `_ document that describes its ex { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Deconst Metadata Envelope", - "type": "object", + "title": "Deconst JSON Slurry", "type": "unknown_meat", "properties": { "body": { "description": "Partially rendered HTML to be injected into a selected layout.",