New evolve docs, take 2: 2/3: user-guide.rst

Angel Ezquerra angel.ezquerra at gmail.com
Thu Jun 5 11:29:21 UTC 2014


On Thu, Jun 5, 2014 at 2:59 AM, Greg Ward <greg at gerg.ca> wrote:
> [Pierre-Yves]
>> I feel like you are mixing both basic user guide feature and more
>> deep theoretical explanation. I wonder if we could built a better
>> distinction between those two things.
>
> [me]
>> Hmmmmmmm. I like it better when people complain about punctuation or
>> terminology. Wholesale rearrangement is a PITA! But I have a horrible
>> feeling, deep in the pit of my stomach, that you might be right. Damn.
>
> [Pierre-Yves]
>> Maybe shuffling the plan like that would work
>>
>> A. Basic command on a head:
>>   1. basic amend usage on a head (skip the marker explanation)
>>   2. basic prune usage on a head
>>   3. basic uncommit usage on a head
>>   4. basic fold usage on a head
>
> ...and DONE! I've just pushed a "small reorganization" of the user
> guide to my personal repo. OK, really, it's nearly a rewrite. I added
> a number of "easy" use cases, illustrated each one, and redrew all the
> figures as SVGs with Inkscape.
>
> You can see the results in glorious black-and-white here:
>
>   http://www.gerg.ca/evolve/user-guide.html
>
> and you can pick nits about the text by replying inline to this:
>
> """
> .. Copyright © 2014 Greg Ward <greg at gerg.ca>
>
> ------------------
> Evolve: User Guide
> ------------------
>
> .. contents::
>
> Live without ``evolve``

Quick comment, shouldn't this be "Life without evolve" (as there is a
later header called "Life with evolve").

Cheers,

Angel



More information about the Evolve-testers mailing list