-
Notifications
You must be signed in to change notification settings - Fork 0
Description
We need to improve the directory structure of the Documentation project. The primary reason for this is to have the common structure of the docs folder for this Documentation project and for the documentations of the libraries. The common structure would reduce the maintenance efforts and free time for writing the documentation itself.
Here is the list of the improvements we need to make and associated reasoning.
-
Move
_codeunderdocs
A library project has the main code and the code associated with the documentation.
The latter should be treated as a part of the documentation. Hence this move request.
It does not relate to this Documentation project but is very much important for a library docs. -
Move binary files under
docs/_bin
Currentlyembed-code-macosare located under the_code. This placement is misleading because these binary files are not part of the code used in the documentation. They are utilities that are needed to generate the documentation. -
Fix the placement and the name of
config-v1.yml
Now the file is placed under the_codedirectory.
The name of the file should be improved to reflect the nature of the file. A preferred name would be likev1.embed-code.yml. The file could be placed along the binaries or in thedocs/_settingsdirectory. -
Move the
_scriptdirectory underdocs
Now the directory is at the root of the project. Since this directory is for documentation only it should be placed underdocs. -
Move the
sitedirectrory underdocsand add the underscore prefix
Since this is a working folder which does not belong to the final content it should come with the_prefix.
Also, the directory makes sense only in the context of the documentation. So it should be under thedocs.
The move is needed for having the common structure for the documentation of the libraries.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status