search

asterisk / documentation

The Asterisk Documentation Project.
https://docs.asterisk.org/
Other
26 stars 22 forks source link

Empty overview doc pages with missing links to subtopics #87

Open Wryhder opened 1 month ago

Wryhder commented 1 month ago

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.

empty page missing links to subtopics-fundamentals

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.

empty page missing links to subtopics-fundamentals-key concepts

TODO: Update issue with links to all empty overview pages.

gtjoseph commented 1 month ago

The page for Asterisk Architecture does have content... image

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.

Wryhder commented 1 month ago

The page for Asterisk Architecture does have content... image

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)?

Wryhder commented 1 month ago

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?

gtjoseph commented 2 weeks ago

@Wryhder Sorry for the delay. If you still want to work on it, why don't you create one or two as an example so we can see what you have in mind and submit a PR. We can go from there.