[llvm-commits] new doc: SphinxQuickstartTemplate.rst

Bill Wendling isanbard at gmail.com
Thu Oct 11 12:29:09 PDT 2012


Hi Sean,

This looks like a fine start. I say go ahead and check it in and we can expand on it later.

Thanks!

-bw

On Oct 11, 2012, at 12:25 PM, Sean Silva <silvas at purdue.edu> wrote:

> Ping?
> 
> On Tue, Oct 9, 2012 at 12:33 AM, Sean Silva <silvas at purdue.edu> wrote:
>> 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




More information about the llvm-commits mailing list