Documentation: please help write the docs!

Software Natron
23

Made a PR. Please feel free to comment there if anything goes wrong.

1 Like
24

Thanks Ivan! We now have a good-looking and searchable documentation!

3 Likes
25

I started to document the Compositing section in the User Guide.
I create a branch from the RB-2.3 branch, but I don’t understand this part of the documentation guide:

‘… give it a name like’ documentation-keying ‘if you are going to write the keying doc …’

Questions

  1. How can I name my fork on github (I currently working on Reformatting elements section)

  2. If I want to document many other Compositing subtopics, what is the simpler way?
    Rename every time my fork, when I edit different topics at the same time? It’s very uncomfortable and weird.

Thank you

1 Like
26

Are you using GitHub Desktop ?
The doc is confusing, but once you know, it’s simple.

  1. Fork natron repo to your repo.
  2. Make a branch from it and call it ‘natron-doc’ for example.
  3. Switch to that branch
  4. Make the changes you want.
  5. Make a pull request to R-B 2.3.
  6. Wait for request to be accepted or not.
1 Like
27

Ok, thank you for your help!

28

And one detail that may not clear in the current doc: do not try to touch the rst files for the plugins documentation (the _group* files or anything in the plugins directory) or the _prefs.rst file, because they are generated automatically

29

I just made more clear in the documentation which files can be edited and which cannot (should be updated on Writing documentation — Natron 2.3.16 documentation within one hour).

You can also improve the documentation on how to write documentation, of course!

1 Like
30

Great! Thank you for quick update!

31

I fixed many links in the docs, especially the python part of it.

3 Likes