Skip to content

docs: add table of contents to README#4901

Open
avasis-ai wants to merge 1 commit intotrufflesecurity:mainfrom
avasis-ai:fix/add-readme-table-of-contents
Open

docs: add table of contents to README#4901
avasis-ai wants to merge 1 commit intotrufflesecurity:mainfrom
avasis-ai:fix/add-readme-table-of-contents

Conversation

@avasis-ai
Copy link
Copy Markdown

@avasis-ai avasis-ai commented Apr 19, 2026

Summary

Adds a table of contents to the README for easier navigation of the extensive documentation.

Changes

  • Added a ## Table of Contents section after the badges and before "What is TruffleHog"
  • Linked all major sections and their subsections using standard Markdown anchor links
  • No content changes, purely navigational addition

Closes #2983


Note

Low Risk
Low risk documentation-only change; no code or behavior is modified.

Overview
Adds a Table of Contents section near the top of README.md, linking to the main documentation headings and key subsections for easier navigation.

Reviewed by Cursor Bugbot for commit 0e73376. Bugbot is set up for automated code reviews on this repo. Configure here.

Add a table of contents to improve navigation of the README document.
Links all major sections and subsections for easier browsing.

Closes trufflesecurity#2983
@avasis-ai avasis-ai requested a review from a team April 19, 2026 17:15
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create table of contents for README.

3 participants