chore: install and init doctoc

KK-1347.

Install doctoc as development dependency. Run the doctoc during the
pre-commit process.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!-- DOCTOC SKIP -->
+
 ## Description
 
 <!-- Describe your changes in detail -->

.husky/pre-commit

@@ -1 +1,2 @@
-yarn lint-staged
+yarn doctoc .
+yarn lint-staged

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+<!-- DOCTOC SKIP -->
+
 # Contributing to Culture Kids front end aka kukkuu-ui
 
 Code contributions are accepted as pull requests. Please make your pull requests as small as possible and

README.md

@@ -1,3 +1,43 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [UI for Kulttuurin kummilapset / Culture Kids](#ui-for-kulttuurin-kummilapset--culture-kids)
+  - [About](#about)
+    - [What?](#what)
+    - [How?](#how)
+    - [When?](#when)
+  - [Deployments](#deployments)
+  - [See also](#see-also)
+  - [Issues board](#issues-board)
+  - [Development](#development)
+    - [Getting started](#getting-started)
+    - [.env variables](#env-variables)
+  - [Available Scripts](#available-scripts)
+    - [`yarn start`](#yarn-start)
+    - [`yarn build`](#yarn-build)
+    - [`yarn serve`](#yarn-serve)
+    - [`yarn test`](#yarn-test)
+    - [`yarn generate:graphql`](#yarn-generategraphql)
+    - [`yarn test:browser`](#yarn-testbrowser)
+      - [Test JWT issuance for browser tests](#test-jwt-issuance-for-browser-tests)
+  - [Docker](#docker)
+  - [Setting up development environment locally with docker](#setting-up-development-environment-locally-with-docker)
+    - [Set tunnistamo hostname](#set-tunnistamo-hostname)
+    - [Create a new OAuth app on GitHub](#create-a-new-oauth-app-on-github)
+    - [Login provider configurations](#login-provider-configurations)
+    - [Install local tunnistamo](#install-local-tunnistamo)
+    - [Install kukkuu locally](#install-kukkuu-locally)
+    - [Headless CMS](#headless-cms)
+    - [kukkuu-ui](#kukkuu-ui)
+  - [Debugging](#debugging)
+    - [Debugging project in VS Code](#debugging-project-in-vs-code)
+    - [Debugging Tests in VS Code](#debugging-tests-in-vs-code)
+    - [Debugging Tests in Chrome](#debugging-tests-in-chrome)
+    - [Debug Redux state](#debug-redux-state)
+  - [Learn More](#learn-more)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 [![codecov](https://codecov.io/gh/City-of-Helsinki/kukkuu-ui/branch/develop/graph/badge.svg)](https://codecov.io/gh/City-of-Helsinki/kukkuu-ui)
 ![Build & Staging](https://github.com/City-of-Helsinki/kukkuu-ui/workflows/Build%20&%20Staging%20&%20Accept/badge.svg)
 

package.json

@@ -156,6 +156,7 @@
     "@graphql-codegen/typescript-operations": "^4.4.0",
     "@graphql-codegen/typescript-react-apollo": "^4.3.2",
     "@types/jsonwebtoken": "^9.0.7",
+    "doctoc": "^2.2.1",
     "husky": "^9.1.7",
     "lint-staged": "^15.3.0"
   }

public/hds-favicon-kit/README.md

@@ -1,18 +1,20 @@
+<!-- DOCTOC SKIP -->
+
 # HDS Favicon kit
 
 Here are the favicons to be used on desktop and mobile web browsers. If you need the Helsinki-logo for general use instead it is available on [the Helsinki brand site](https://brand.hel.fi/tunnus/).
 
 The favicons are available in the following sizes and formats:
 
-* favicon-32x32.ico (32x32px)
+- favicon-32x32.ico (32x32px)
 
-* favicon.svg (512x512px, dark mode support)
+- favicon.svg (512x512px, dark mode support)
 
-* apple-touch-icon.png (180x180px)
+- apple-touch-icon.png (180x180px)
 
-* favicon-192x192.png (192x192px, webmanifest)
+- favicon-192x192.png (192x192px, webmanifest)
 
-* favicon-512x512.png (512x512px, webmanifest)
+- favicon-512x512.png (512x512px, webmanifest)
 
 Note that [SVG favicon support](https://caniuse.com/link-icon-svg) for dynamic dark mode is not supported by all browsers like Safari.
 

src/domain/auth/README.md

@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [HDS LoginProvider configurations](#hds-loginprovider-configurations)
+  - [Tunnistamo (a local instance in local development)](#tunnistamo-a-local-instance-in-local-development)
+- [Keycloak (a test environment in local development)](#keycloak-a-test-environment-in-local-development)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # HDS LoginProvider configurations
 
 Examples of the configurations for a local Tunnistamo and the Keycloak in the test environment.