de Publieke Partner|Kennisbank

Sidebar & navigatie

Deze kennisbank gebruikt nu bewust een eenvoudige, leidende interne boom onder docs/intern/.

Basisregel

Alleen pagina's onder docs/intern/** kunnen in de zichtbare sidebar komen.

Legacy-content onder bijvoorbeeld docs/automation/, docs/handboek/ en docs/beheer/ blijft beschikbaar als bron of directe URL, maar is niet leidend voor de navigatie.

Een item zichtbaar maken

  1. Maak of gebruik een pagina onder docs/intern/....
  2. Geef de pagina sidebar_show: true.
  3. Geef de pagina een sidebar_position.
  4. Zorg dat elke parent-map ook een eigen index.md of index.mdx heeft met sidebar_show: true.

Voorbeeld:

---
title: Automatisering
sidebar_position: 3
sidebar_show: true
kb_visibility: internal
---

Volgorde en labels

  • Gebruik sidebar_position voor de volgorde.
  • Gebruik sidebar_label alleen als de navigatienaam korter of duidelijker moet zijn dan de paginatitel.
  • Houd de boom ondiep en groepeer eerst op onderwerp, niet op losse systemen.

Een item verbergen

Gebruik een van deze routes:

  • sidebar_show: false of het veld weglaten: niet zichtbaar in de sidebar.
  • kb_hide: true: volledig verborgen voor router, zoekindex en assistent.
  • kb_public: false: intern-only; niet voor publieke exposure.

Een bron hergebruiken

Gebruik source_path als een pagina in docs/intern/ de inhoud van een bestaande bronpagina moet tonen zonder duplicatie.

Voorbeeld:

---
title: Diensten & endpoints
sidebar_show: true
source_path: handboek/techniek/endpoints
---

Daarmee blijft de inhoud op één plek onderhoudbaar, terwijl de zichtbare navigatie toch onder Intern blijft.

Zoekindex en assistent

  • De statische zoekindex volgt alleen de zichtbare docs/intern/**-pagina's.
  • De KB-indexer voor de assistent volgt dezelfde zichtbare interne boom.
  • source_path-pagina's gebruiken daarbij de broninhoud, maar houden het interne pad als leidende route.

Praktische afspraak

  • Nieuwe zichtbare interne documentatie begint onder docs/intern/.
  • Oude roots pas verplaatsen of verwijderen als de interne route stabiel is.
  • Bij twijfel eerst een interne aliaspagina toevoegen met source_path, daarna pas inhoud migreren.