Repository navigation
Empty overview doc pages with missing links to subtopics #87
Description
Activity
The page for Asterisk Architecture does have content...
Adding links to sub-topics in the overview content pages is tricky because the navigation is generated dynamically by mkdocs. I'll see if there's some way we can handle it.
The page for Asterisk Architecture does have content...
Yes, I included this as an example of an overview page with some content. I suppose I didn't express that clearly.
Adding links to sub-topics in the overview content pages is tricky because the navigation is generated dynamically by mkdocs. I'll see if there's some way we can handle it.
What should go into the overview docs? Will a summary of the ideas in the subsections suffice (with relevant links to each subsection within the overview text, along with footer links to the previous and next page of the current page)?
- changed the title
[-]Empty doc pages with missing links to subtopics[/-][+]Empty overview doc pages with missing links to subtopics[/+]on May 13, 2024 What should go into the overview docs? Will a summary of the ideas in the subsections suffice (with relevant links to each subsection within the overview text, along with footer links to the previous and next page of the current page)?
@gtjoseph Hi! I wanted to ask if you'll be creating the overview pages in-house, or could I work on it?
Trying to use this documentation has been a pretty frustrating experience to say the least. Most of the pages just say under construction and have blank content. Where's the actual documentation?
@ipaqmaster I can't take a look right now, but wasn't it mostly the overview pages that have missing content?
If you use the left sidebar navigation and expand the link categories with the arrows, there's a lot of existing documentation. Unless there's something specific not covered?
(Not sure where you can get a faster response from the team.)
Yes just the top levels though I got myself set up a little easier with the sample configuration. I expected the official documentation to be more helpful. Or perhaps just more complete.
@ipaqmaster Give me some examples of where it could be more helpful. There's tons of documentation but the category pages are sparsely populated so if you're not using the left navigation bar you might not see it.
Expected behaviour: Clicking on a high-level topic or a label used to organize related subtopics should open an overview page with some content (e.g, Fundamentals > Asterisk Architecture) or load the first sub-item (e.g, Getting Started > Beginning Asterisk).
Actual behaviour: There are several empty overview pages.
Based on pages like the one below, the docs are being developed. I'd still like to suggest including links to the sub-topics or sub-items on the overview page (in addition to the under construction warning) pending when the overview content is created.
TODO: Update issue with links to all empty overview pages.