-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Individual project overviews #127
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: