medic / cht-docs

Documentation site for the Community Health Tookit
https://docs.communityhealthtoolkit.org
14 stars 18 forks source link

Fix 'CHT API' & 'Partials' #1008

Open abbyad opened 1 year ago

abbyad commented 1 year ago

The _partial files are coming up in ways they shouldn't:

In this particular case, the missing context makes the appearance of these partials confusing. For instance, it's not clear the difference between CHT API and API to interact with CHT Applications.

Aside from fixing these, we should consider updating the docs style guide to provide guidance on the _partial_ files.


Page: /apps/reference/_partial_cht_api/ Page: /apps/reference/_partial_utils/ Version: 2023-04-04 14:00:43 1200 1200

Screenshots

Utils correctly pulled into other pages

image

Utils showing up when it shouldn't

image image image image image
abbyad commented 1 year ago

Local docker setup too!

image
abbyad commented 1 year ago

For future reference, the Docsy theme that we use makes it possible to omit pages from the lefthand table of contents and the index page summaries with instructions in the front matter:

To hide a page or section from the left navigation menu, set toc_hide: true in the front matter.

To hide a page from the section summary on a docs section landing page, set hide_summary: true in the front matter. If you want to hide a page from both the TOC menu and the section summary list, you need to set both toc_hide and hide_summary to true in the front matter.

I've also noticed experimentally that ommiting front matter altogether makes the page not show up in TOC and Index, but it is not clear if that will always be the case, so better to use the specified instructions.