Page MenuHome

Updating the VSE documentation
Confirmed, NormalPublic

Description

Updating the VSE documentation for a work-flow oriented standpoint/

A work in progress can be found here: https://vse-docs.readthedocs.io/en/latest/index.html

Event Timeline

Aaron Carlisle (Blendify) changed the task status from Needs Triage to Confirmed.Thu, Apr 22, 10:03 PM
Aaron Carlisle (Blendify) updated the task description. (Show Details)

In the Readthedocs VSE documentation, I refer to the original manual with external links (e.g. https://docs.blender.org/manual/ ...). I can use also internal links (e.g. :doc:...) but then I should know the exact path where the future VSE docs will reside. At the moment, there is a section video_editing (with 2 sub folders sequencer & preview). Perhaps the new VSE docs will reside there? Is it OK then to create internal links to the other manual sections; for example to the Tabs & panel section with :doc:Tabs & panels </interface/window_system/tabs_panels.rst> This will work in the local preview (auto_build) on my machine and eventually later on at the Blender site, but not in the ReadTheDocs site).

Whichever works best for your workflow, by the time things get merged everything should use internal links.