⚠️ 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-On-Codespaces.md provides a detailed step-by-step guide, but it currently lacks a Table of Contents (TOC). As the guide is quite long and structured into multiple sections, a TOC would significantly improve navigation and usability.

Adding a TOC will help users quickly jump to specific steps such as setup, running scans, or troubleshooting.

Goal

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

What needs to be done

• Add a TOC below the main title (# Run ScanAPI on GitHub Codespaces)

• Include links to all main sections:

  • Open your fork in Codespaces
  • Wait for setup to finish
  • Add the examples folder
  • Verify the environment
  • Run your first scan
  • View the report (browser)
  • Try another example
  • Troubleshooting

• Include relevant subsections where helpful (e.g. inside sections 3, 4, and 8)

• Ensure all links work correctly using Markdown anchor links

Example

Here is an example of how the TOC could look:

## Contents

- [1. Open your fork in Codespaces](#1-open-your-fork-in-codespaces)
- [2. Wait for setup to finish](#2-wait-for-setup-to-finish)
- [3. Add the examples folder](#3-add-the-examples-folder)
  - [3.1 Add the folder](#31-add-the-folder)
  - [3.2 Save the workspace](#32-save-the-workspace)
  - [3.3 Reopen later](#33-reopen-later)
- [4. Verify the environment](#4-verify-the-environment)
  - [4.1 Check ScanAPI is installed](#41-check-scanapi-is-installed)
  - [4.2 Run project checks](#42-run-project-checks)
- [5. Run your first scan](#5-run-your-first-scan)
- [6. View the report (browser)](#6-view-the-report-browser)
- [7. Try another example](#7-try-another-example)
- [8. Troubleshooting](#8-troubleshooting)

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