summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2018-04-18 16:08:08 +0100
committerJavier Jardón <jjardon@gnome.org>2018-04-18 16:25:10 +0100
commit899c3ce07dbbbebc0ed30b7cff3463fa9a133fd4 (patch)
tree0e7b3dff82d7f88e16fbf7ae6269a1c6a1d8a771
parentcd75869feb24ef2b0f3583aa2533ccef674534a3 (diff)
downloadbuildstream-899c3ce07dbbbebc0ed30b7cff3463fa9a133fd4.tar.gz
doc/source/index.rst: Replace welcome paragraphjjardon/doc_readme
-rw-r--r--doc/source/index.rst17
1 files changed, 7 insertions, 10 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ed6d35fa1..1b532afb1 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -4,18 +4,15 @@
contain the root `toctree` directive.
-BuildStream Documentation
-=========================
+Welcome to BuildStream’s documentation!
+=======================================
-About BuildStream
------------------
-BuildStream is a flexible and extensible framework for the modelling of build
-pipelines in a declarative YAML format, written in python.
-
-These pipelines are composed of abstract elements which perform mutations on
-*filesystem data* as input and output, and are related to eachother by their
-dependencies.
+These docs cover everything you need to build and integrate software stacks
+using BuildStream.
+They begin with a basic introduction to BuildStream, background
+information on basic concepts, and a guide to the BuildStream command line interface.
+Later sections provide detailed information on BuilStream internals.
.. toctree::
:maxdepth: 2