⚠️ Reserved for Conference Tutorial

This issue is currently reserved for participants of a tutorial at PyCon DE & PyData 2026. It is part of a guided session, so contributions may be coordinated during the event. If the issue is not resolved during the tutorial, it will be reopened for general contributions afterward. Thank you for your understanding and interest in contributing 💜

Description

The document wiki/Run-ScanAPI-Locally-Manually.md is a detailed guide with multiple sections, but it currently lacks a Table of Contents (TOC). Adding a TOC would improve navigation and make it easier for users to jump directly to specific steps.

Goal

Add a Table of Contents to the top of the document with links to all main sections and relevant subsections.

What needs to be done

• Add a TOC below the main title (# Run ScanAPI locally manually)

• Include links to all main sections:

  • Local Setup
  • Install requirements
  • Clone your fork
  • Clone the examples repository
  • Install dependencies
  • Verify the environment
  • Run your first scan
  • View the report
  • Try another example

• Include subsections where applicable (e.g. section 5)

• Ensure all links work correctly using Markdown anchor links

Example

Here is an example of how the TOC could look:

## Contents

- [Local Setup](#local-setup)
- [1. Install requirements](#1-install-requirements)
- [2. Clone your fork](#2-clone-your-fork)
- [3. Clone the examples repository](#3-clone-the-examples-repository)
- [4. Install dependencies](#4-install-dependencies)
- [5. Verify the environment](#5-verify-the-environment)
  - [5.1 Check ScanAPI version](#51-check-scanapi-version)
  - [5.2 Run project checks](#52-run-project-checks)
- [6. Run your first scan](#6-run-your-first-scan)
- [7. View the report](#7-view-the-report)
- [8. Try another example](#8-try-another-example)

Acceptance criteria

• A TOC is added at the top of the document
• All links correctly navigate to their respective sections
• Subsections are included where useful
• Formatting is clean and easy to read
• No existing content is broken or altered unintentionally