Documentation Structure

Updated 471 Days AgoPublic

Actions

To manage to collate all the documentation and make a good user experience we need to plan carefully what structure we should use, what areas need to be added, and which parts of the site are no longer needed. This provides the structure proposed to organise T5827 and encompass all the changes in ticket T5826.

Migration

As we need to keep all of the old documentation online its important that no content is deleted - only moved if required.
Additionally most of this documentation will refer to the EFL interfaces release in EFL 1.21 and so we can't publish as we go.
Thankfully the proposal below allows for this - new documentation will not be created at existing URLs (with the exception of the main /docs page - which we will have to do last) old documentation will either be moved into /develop/legacy, have all links updated or will be left in place and have the valuable content adapted into the new docs.

We are also taking this opportunity to move to markdown documentation. All new files should be .md.txt instead of .txt (or, if adding from the web, pages should end with .md). Any pages which do not need to be changed in the restructure (not many) should be converted to markdown. Any .txt files in the repository will be interpreted as not yet ported to the new docs structure.

Structure

The following is a suggested layout with reference to the source / summary of each area:

The following tables show the list of variants we are supporting - used to substitute <lang> above.