Add `black-primer` docs (#1427)

[etc/vim.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0106c9cfdc8d555bfa494f25aff25b9a6be54f84..4ca9877a3c445904256346ff910b642f8d18fe68 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,25 +1,24 @@
 .. black documentation master file, created by
    sphinx-quickstart on Fri Mar 23 10:53:30 2018.
 
 .. black documentation master file, created by
    sphinx-quickstart on Fri Mar 23 10:53:30 2018.
 

-Black
-=====
+The uncompromising code formatter
+=================================

 
 

-**Black** is the uncompromising Python code formatter. 
-
-By using *Black*, you
-agree to cease control over minutiae of hand-formatting. In return,
-*Black* gives you speed, determinism, and freedom from `pycodestyle`
-nagging about formatting. You will save time and mental energy for
-more important matters.
+By using *Black*, you agree to cede control over minutiae of
+hand-formatting. In return, *Black* gives you speed, determinism, and
+freedom from `pycodestyle` nagging about formatting. You will save time
+and mental energy for more important matters.

 
 *Black* makes code review faster by producing the smallest diffs
 possible. Blackened code looks the same regardless of the project
 you're reading. Formatting becomes transparent after a while and you
 can focus on the content instead.
 
 
 *Black* makes code review faster by producing the smallest diffs
 possible. Blackened code looks the same regardless of the project
 you're reading. Formatting becomes transparent after a while and you
 can focus on the content instead.
 

+Try it out now using the `Black Playground <https://black.now.sh>`_.
+

 .. note::
 
 .. note::
 

-   Black is an early pre-release.
+   `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.

 
 
 Testimonials
 
 
 Testimonials


@@ -29,7 +28,7 @@ Testimonials
 
    *Black is opinionated so you don't have to be.*
 
 
    *Black is opinionated so you don't have to be.*
 

-**Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
+**Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core

 developer of Twisted and CPython:
 
    *An auto-formatter that doesn't suck is all I want for Xmas!*
 developer of Twisted and CPython:
 
    *An auto-formatter that doesn't suck is all I want for Xmas!*


@@ -49,11 +48,20 @@ Contents
 .. toctree::
    :maxdepth: 2
 
 .. toctree::
    :maxdepth: 2
 

-   usage
-   technical_philosophy
-   contributors_guide
-   changelog
-   
+   installation_and_usage
+   the_black_code_style
+   pragmatism
+   pyproject_toml
+   editor_integration
+   blackd
+   black-primer
+   version_control_integration
+   ignoring_unmodified_files
+   contributing
+   show_your_style
+   change_log
+   reference/reference_summary
+   authors

 
 Indices and tables
 ==================
 
 Indices and tables
 ==================