glusterdocs icon indicating copy to clipboard operation
glusterdocs copied to clipboard

[RFE] Auto generate documentation from directory contents

Open black-dragon74 opened this issue 3 years ago • 1 comments

Instead of manually specifying the nav in mkdocs.yml we could autogenerate the nav links based on the directory structure.

The idea is to have a python script which does this automatically for us and then it calls the mkdocs build.

The result will be a cleaner mkdocs.yml file and to add any new section/content we will just have to create a markdown file under a directory.

Please share your thoughts.

/cc: @Shwetha-Acharya @kshithijiyer @aravindavk

black-dragon74 avatar May 31 '22 09:05 black-dragon74

-1

Keeping the required order of the chapters is difficult if it is crawl based. Directories and file names should use number prefix so that order can be maintained (Ex: 002-Install-Guide/001-Overview.md). Reorganizing or introducing a chapter is very difficult(Imagine adding a chapter between 002-* and 003-*)

aravindavk avatar May 31 '22 15:05 aravindavk