Skip to content

Add section index to README feature matrix #1033

@brendancol

Description

@brendancol

Author of Proposal: automated

Reason or Problem

The feature matrix in the README now spans 18 category sections and 90+ functions. Finding a specific section means scrolling through a lot of tables.

Proposal

Design:
Add a single-line index of category links right after the "Supported Spatial Functions" heading. Something like:

**Jump to:** Classification · Diffusion · Focal · ... · Utilities

Each name links to its corresponding section anchor. Compact enough that it doesn't dominate the page visually.

Usage:
Click a category name to jump to that section.

Value: Faster navigation for anyone scanning the README for a specific tool category.

Stakeholders and Impacts

Documentation-only change. No code or test impact.

Drawbacks

Adds one more line to the README. The index itself needs updating when new sections are added.

Alternatives

  • <details> accordion (hides the index but adds a click)
  • Do nothing (browser Ctrl+F still works)

Unresolved Questions

None.

Additional Notes or Context

None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions