← All ideas
  • Published 20 Mar 2020

Updating documentation

I don't know if the devs have this planned, but i find the documentation really lacking. I think they should dedicate a month or two and maybe more to go through the documentations. Some info there is really oudated and some are bareboned, like "X controls Y", but no actual info on what Y is. So i just have to end up guessing what everything does. Makes things really hard, especially when it comes to simulations that takes long to bake to just check.

75%

Development Status: Open

Upvote 3 Downvote 1
BacMan12
20 Mar 2020

11 Comments

Josephbburg

The devs did spend months updating the documentation when 2.80 was released. Anyone can update the docs, though. What specifically were you having trouble with? You didn't even make it clear whether you're talking about the Python Documentation or the manual.

It's worth mentioning that ALL of the docs are online, including previous versions. If you found outdated information, it's likely you were looking at an outdated manual. I usually go directly to docs.blender.org instead of using search engines, because they rarely take me to the latest manual.

2
BacMan12 Author

* @Josephbburg * I had a feeling that i heard that they updated it some while ago, forgot. And yes, i mean the manual. I know everyone can update it, but i don't think many do. Also i can't, i need to learn the subject first. I rarely use google to search it up, i use the F1 shortcut, that works for most things i click, but usually sends me to the wrong place.

1
jason

In addition to other things brought up, it's a good thing to know that documentation is one of the places where non-developer Blender users can be a part of Blender development. The documentation for Blender is just as open source as Blender is. They're always looking for help and people to update documentation. It just takes your willingness to do it.

1
jeric_synergy

I wouldn't mind more redundancy in the dox, specifically, more examples: sometimes an explanation is poorly worded, or simply an obscure concept, and having a few >different< explanations might help.

It's not like we're killing trees for the documentation.

1
jaroslav.zaruba

Update: Thanks to @Josephbburg for posting the link: docs.blender.org/manual/en/latest/about/contribute/editing.html

I don't know how to go about it either. On the page I would like to update (once I get confirmation it needs the update) there seem to be no link for that. A login-form is hidden under the button "Personal tools", but there's no "Register" link.

pipeliner

you can help to update the documentation

jeric_synergy

* @pipeliner * I attempted to, but the process seemed obscure.

1
pipeliner

* @jeric_synergy * why?

jeric_synergy

* @pipeliner * The page I was attempting to add/alter was a Wiki, but I could not determine how to submit changes.

1
Josephbburg

* @jeric_synergy * I don't think users have permissions for the wikis. The documentation are built with Doxygen, and must be cloned from the git repo.

Instructions are here: docs.blender.org/manual/en/latest/about/contribute/index.html

2
jaroslav.zaruba

Well that's not very encouraging. I can't imagine many people want to do this. :(