[llvm-commits] new doc: SphinxQuickstartTemplate.rst

Sean Silva silvas at purdue.edu
Mon Oct 8 21:33:02 PDT 2012


This document is the result of thinking about how to get people
writing new documentation as fast as possible. After a couple attempts
in different expository formats, I settled on the current format which
is a document that is meant to be copied into a new file and used as a
template for the new documentation. It is expected to be read inside a
text editor.

The goal is to take someone in the state of "I want to write
documentation and get it added to LLVM's docs" and turn that into
useful documentation mailed to llvm-commits with as little nonsense as
possible.

The logic is that documentation contributors should not be burdened
with janitorial details which can be easily done after the fact.

Feedback? Agree/disagree with the approach?

-- Sean Silva
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-docs-Add-SphinxQuickstartTemplate.rst.patch
Type: application/octet-stream
Size: 5083 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20121009/e6d029ca/attachment.obj>


More information about the llvm-commits mailing list