Skip to content

Fix #2983: Create table of contents for README.#4788

Open
Br1an67 wants to merge 1 commit intotrufflesecurity:mainfrom
Br1an67:fix/issue-2983-fix-2983
Open

Fix #2983: Create table of contents for README.#4788
Br1an67 wants to merge 1 commit intotrufflesecurity:mainfrom
Br1an67:fix/issue-2983-fix-2983

Conversation

@Br1an67
Copy link

@Br1an67 Br1an67 commented Mar 4, 2026

Fixes #2983

Description:

Explain the purpose of the PR.

Checklist:

  • Tests passing (make test-community)?
  • Lint passing (make lint this requires golangci-lint)?

Note

Low Risk
Low risk documentation-only change; the main risk is minor broken anchor links if headings change or GitHub anchor generation differs.

Overview
Adds a new Table of Contents section to README.md, linking to the major feature and usage sections (including nested subsections like Discovery, Configuration, and S3) to improve navigation.

Written by Cursor Bugbot for commit a59ae5e. This will update automatically on new commits. Configure here.

Added a table of contents section to improve navigation of the README
document.

Co-Authored-By: Claude <noreply@anthropic.com>
@Br1an67 Br1an67 requested a review from a team March 4, 2026 18:05
@CLAassistant
Copy link

CLAassistant commented Mar 4, 2026

CLA assistant check
All committers have signed the CLA.

@kashifkhan0771
Copy link
Contributor

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.

@Br1an67 ⬆️

@Br1an67 Br1an67 force-pushed the fix/issue-2983-fix-2983 branch from ebd7698 to a59ae5e Compare March 6, 2026 04:40
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