Hi!
Ravenwing wrote:Is ReST more of a general concept, or is it an actual language? If it's an actual language, is
this the correct reference I should be using?
ReST is the syntax we're using, and sphinx is the "compiler" used to turn the ReST into HTML. I use the primer available on the
Sphinx website since it's nicely formatted.
Ravenwing wrote:Do we have any references for how to go about authoring documentation? Do we have an official style guide for the actual content?
Since you're not documenting the source code I don't know. I have a layout set up with some basic guidelines for the code part, but nothing else. If you don't find anything and no one says differently, feel free to write up a document on it.
Ravenwing wrote:Have we decided to use American or British English?
I consciously use British English, but since I'm Swedish I've mostly learned American English, so it might bleed through.
Ravenwing wrote:If DavidD is working on source docs and I work on user docs, I doubt this will be a problem, but is there an established way of not accidentally working on the same doc and overwriting the other's work?
We got the documentation under source control. We use Git; it helps with conflicts when two people modify the same files and also keeps track of file history, so mistakes can always be undone.
Ravenwing wrote:Is there anything else I need to know about standard procedures for this kind of stuff? I am skimming the wiki on what developers need to follow, but there's a lot there and most of it doesn't pertain to me, so I may miss some things.
Mostly just Git related things. Knowing how to fork a repository, committing, pushing, merging, and pull requests will get you far. Since the documentation is mostly unwritten, you have pretty free hands. The source documentation is located inside the docs/source folder. The "openmw" folder is currently used for the source code, and the "openmw-cs" is for the cs manual.
If you need any help or have any questions, feel free to ask here!
What are you considering writing about?