From cf657ebadcdace64eaf2b1beaf046883f46b5de2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 26 Oct 2023 17:26:11 +0200 Subject: [PATCH] chore(docs): update TOC (test-branch -> development) (#731) Bug: T332715 --- docs/AdminGuide.md | 9 ++++++++- docs/README.md | 17 +++++++++++++++-- docs/UserGuide.md | 12 +++++++++++- 3 files changed, 34 insertions(+), 4 deletions(-) diff --git a/docs/AdminGuide.md b/docs/AdminGuide.md index e4882393..8f5e562b 100644 --- a/docs/AdminGuide.md +++ b/docs/AdminGuide.md @@ -1,6 +1,13 @@ - + +**Table of Contents** + +- [Mismatch Finder Administration Guide](#mismatch-finder-administration-guide) + - [Managing Upload Users](#managing-upload-users) + - [Managing Imported Mismatches](#managing-imported-mismatches) + - [Log Track of Users' Review Decisions](#log-track-of-users-review-decisions) + - [Update the expiry date of mismatches](#update-the-expiry-date-of-mismatches) diff --git a/docs/README.md b/docs/README.md index 19af0fbd..76b35578 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,22 @@ # Developer Documentation - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +**Table of Contents** + +- [Quickstart](#quickstart) +- [Day to day](#day-to-day) +- [Working with OAuth](#working-with-oauth) +- [Frontend - Working with CSS and JS](#frontend---working-with-css-and-js) +- [Localization and Internationalization](#localization-and-internationalization) +- [Job Queues](#job-queues) +- [Linting](#linting) +- [Testing](#testing) +- [Staging](#staging) +- [Troubleshooting](#troubleshooting) +- [Chore: Updating dependencies](#chore-updating-dependencies) +- [See also](#see-also) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 46dd3de6..0926823c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,8 +1,18 @@ # Mismatch Finder User Guide - + +**Table of Contents** + +- [Logging in](#logging-in) +- [Accessing the API](#accessing-the-api) +- [Obtaining an API access token](#obtaining-an-api-access-token) +- [Importing mismatches](#importing-mismatches) + - [Creating a mismatches import file](#creating-a-mismatches-import-file) + - [Getting upload rights](#getting-upload-rights) + - [Uploading an import file](#uploading-an-import-file) + - [Reviewing Mismatches](#reviewing-mismatches)