Page MenuHome

Split up "getting started" section
Closed, ResolvedPublic

Description

The getting started section seems to contain all sorts of not-necessarily-related info (such as conventions used in the manual and documentation on openGL rendering).
This seems a little inconsistent with the rest of the manual, which is split into sections based on how blender is organized, rather than difficulty or "what should be learned first".

Since this manual is intended as more of a reference manual (rather than a tutorial or teaching course), I propose a re-organization of this section as follows:

FromToNotes
basics/startup_file.rstpreferences/startup_file.rstWhile not part of the user preference editor, it is a large part of configuring and customizing blender.
basics/help.rsttroubleshooting/general_help.rst
basics/undo_and_redo.rsttroubleshooting/recovering.rst
basics/quick_render.rstrender/opengl.rstThis page contains a lot of general render info not directly relevant to opengl rendering. Perhaps this should be moved to other rendering pages (or just removed).
basics/interface/interfacePerhaps this could be moved to it's own root-level chapter, or combined with the editors chapter. (e.g. move editors into interface)
basics/screencasts.rst/interface/screencast.rstThis could go inside of the interface directory, wherever it ends up (see above). If there are more "UI tool" pages like this one, perhaps a tools subdirectory could work (/interface/tools/screencasts.rst).
basics/screenshots.rst/interface/screenshot.rstSame as above.
basics/navigating/editors/3dview/navigateThis section mainly deals with the 3D view. More generic navigation docs will go here instead, see T43668
basics/transformations/editors/3dview/transformMost of this section appears to deal the the 3D view specifically. Perhaps generic parts could be split into /interface/transform, but probably simpler to just ensure that it's mentioned where transforms work in other editors too.
about_blender/about_this_manual.rst/glossary/conventions.rstSince this page describes conventions used in the manual more from a user perspective (not a contributer perspective), maybe it could be integrated into the glossary or something?

Perhaps /getting_started/index.rst can be turned into a sort of "how to use this manual" introduction page, and include a few potential "where to go first" links (e.g. installing_blender)

Revisions and Commits

Related Objects

Event Timeline

Kitt Zwovic (gandalf3) raised the priority of this task from to 90.
Kitt Zwovic (gandalf3) updated the task description. (Show Details)
Kitt Zwovic (gandalf3) edited a custom field.

Agree that basics/ is overloaded and needs reorganization.

Generally your proposel looks good.

  • Would leave about_blender and installing_blender where they are now, think its not necessarily in the best place currently... but rather not add too many root-level sections.
  • Disagree with moving basics/navigating to /interface/navigating, this is currently docs for the 3d-viewport. So it could be moved into /editors/3dview/navigation ?

All other changes seem fine.


Note, we have a tool to move paths around, see: tools/rst_remap.py, this avoids having to do a lot of manual edits.

@Campbell Barton (campbellbarton) Sounds good!

Re basics/navigating, not exactly sure what the idea with this section is yet (see T43668#332493).

@Kitt Zwovic (gandalf3), AFAICS the existing content belongs in /editors/3dview/navigation, and dont see any issues with moving it there.

We could add some navigation basics doc later.

Aaron Carlisle (Blendify) lowered the priority of this task from 90 to Normal.Sep 8 2015, 2:18 PM
Kitt Zwovic (gandalf3) changed the task status from Unknown Status to Resolved by committing rBM593: Fix T46017.Sep 10 2015, 11:56 PM