⚠️ 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-with-Dev-Container.md is a detailed step-by-step guide, but it currently lacks a Table of Contents (TOC). Given its length and structure, adding a TOC would make it much easier for users to navigate between sections.

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 with Dev Container)

• Include links to all main sections:

  • Dev Container setup
  • Install requirements
  • Clone your fork
  • Open in Dev Container
  • Verify the environment
  • Run your first scan
  • View the report
  • Try another example

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

• Ensure all links work correctly using Markdown anchor links

Example

Here is an example of how the TOC could look:

## Contents

- [Dev Container setup](#dev-container-setup)
- [1. Install requirements](#1-install-requirements)
- [2. Clone your fork](#2-clone-your-fork)
- [3. Open in Dev Container](#3-open-in-dev-container)
- [4. Verify the environment](#4-verify-the-environment)
  - [4.1 Check ScanAPI version](#41-check-scanapi-version)
  - [4.2 Run project checks](#42-run-project-checks)
- [5. Run your first scan](#5-run-your-first-scan)
- [6. View the report](#6-view-the-report)
- [7. Try another example](#7-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