You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently only one overview can be defined in a project. In the case of a multi project structure this seems like a major limitation, It is possible to define an overview which includes sections for each project but this is a clunky solution that impairs user experience.
Proposed solution
I would propose a modification to the docs app that would allow a user to define a docs block in an .md file that by simply using a particular naming convention for example {% docs <project name>_overview %}. That block would be used in place of the main overview whenever the user clicks on the root folder of the project in the file tree, and/or perhaps adds some tabbed selection area in the overview panel.
Benefits
This would allow anyone building a project that includes sub-project to easily define more intuitive and extensive documentation.
The text was updated successfully, but these errors were encountered:
Defining the problem
Currently only one overview can be defined in a project. In the case of a multi project structure this seems like a major limitation, It is possible to define an overview which includes sections for each project but this is a clunky solution that impairs user experience.
Proposed solution
I would propose a modification to the docs app that would allow a user to define a docs block in an .md file that by simply using a particular naming convention for example {% docs <project name>_overview %}. That block would be used in place of the main overview whenever the user clicks on the root folder of the project in the file tree, and/or perhaps adds some tabbed selection area in the overview panel.
Benefits
This would allow anyone building a project that includes sub-project to easily define more intuitive and extensive documentation.
The text was updated successfully, but these errors were encountered: