Andy schrieb:
> I have no idea how it fits in with anyone else's plans, but I felt I
> could improve on the Controller Getting Started Guide, so I made a new
> version and put it on 1.0/RoughDocs.
So, do you propose to replace the old Controller Getting Started Guide
or do you see your document as a complement to it?
> It's there for everyone to see, so I guess now I'll find out if anyone
> else likes it or if I will be exiled to a small island without net
> access.
In fact, could you please open a task ticket on trac reminding us to
review this document? Be sure to choose "Docs" as the component.
I would like to utilize the ticket tracker more to keep us on top of
documentation tasks, since in the past few months, the doc effort has
been a bit un-coordinated and neglected, mainly due to the lack of
someone taking responsability for it (BTW: does anybody know what
happened to Karl Guertin?).
I'm not saying that I want to be the one, but in the absence of someone
else who feels the docs are his (or her) vocation, I'll try to do my best.
Also, here are a few tips for style & ReST markup:
* First-level list should have no indentation.
* The Page Title and Section Headings Should Use Capitalization. (except
for articles, conjunctions, and short prepositions, etc.)
* All lines should be wrapped at 80 characters.
(I usually use my local text editor to edit pages and past them
when they are ready.)
* If you have a literal section, and the preceding line ends with a
colon, just double that colon and you don't need two colons on a
single line::
Literal block
* The plural of URL should be written as URLs (no apostrophe).
* For the ReST link syntax in `Callout Style`_, the link target should
not be enclosed in backticks and case does not matter. Long URLs can
be put on the next line with indentation.
* Put an empty line before and after section headings and keep the
underline the same length as the section title (you can do this
at the final proof-reading phase).
* In short, treat the ReST source as you would treat Python source code
you want this to be beatiful as well.
.. _callout style:
http://docutils.sourceforge.net/docs/user/rst/quickref.html#contents
Please don't be taken aback by these remarks, your style and formatting
of the documents is better than that of most wiki contributors, so
thatswhy I found it worthwhile to give you some hints to make it perfect!
Thanks a lot!
Chris
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"TurboGears Docs" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/turbogears-docs?hl=en
-~----------~----~----~----~------~----~------~--~---
