From 8c735b62cc276d91602072964ca48739ec877ce8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benedikt=20R=C3=B6tsch?= Date: Tue, 2 Jan 2024 19:11:25 +0100 Subject: [PATCH] docs: document core helper functions --- packages/docs/docs/new-structure.md | 3 ++- packages/docs/sidebars.js | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/docs/docs/new-structure.md b/packages/docs/docs/new-structure.md index 42e78b21..08a9294c 100644 --- a/packages/docs/docs/new-structure.md +++ b/packages/docs/docs/new-structure.md @@ -16,7 +16,8 @@ * DONE - @todo sub-section that turns all of this into typescript? (or have separate typescript tutorial?) * DONE - @todo add another guide on how to handle tracking in single page applications (or ones that use routers) * DONE - @todo we actually need to list the config options (COMPONENETS dir????) -* @todo document helper functions + hooks (getForegroundColor, createIconComponentFromSimpleIconsSvgPath) +* @todo document helper functions in core + default interface +* @todo document hooks in core + default interface * @todo double check that we dont have no more "cosntruction" sites * check again if we can add typescript related help into some guides or other parts of the docs diff --git a/packages/docs/sidebars.js b/packages/docs/sidebars.js index d1b434b3..f7e97022 100644 --- a/packages/docs/sidebars.js +++ b/packages/docs/sidebars.js @@ -12,6 +12,7 @@ module.exports = { 'core/consent-manager', 'core/consent-manager-form', 'core/privacy-shield', + 'core/helpers', ], 'Core Hooks': ['todo'], 'Default Interface': [