Skip to content

[FEATURE] Table of contents block #76

@alongwill

Description

@alongwill

Feature Summary

For long runbooks it would be useful to have an optional "table of contents" block at the top to show the user at a glance what content is available at a high level.

  • This would be generated from existing headings in the runbook
  • Each heading in the table of contents would be a clickable link that jumps to the relevant heading

Problem/Use Case

If you have a long runbook then having a table of contents makes it easier to navigate.

Proposed Solution

Create a new "table of contents" block.

Current Workaround

Search or scroll through a runbook

Detailed Description

User Interface

How would users interact with this feature?

  • Create the new block where they want in the runbook
  • As they add headings, the "table of contents" block automatically updates

Integration Points

Would this feature need to integrate with:

  • Shell/Terminal
  • Database clients
  • HTTP/API calls
  • File system
  • External tools (specify): ___
  • Other: ___

Alternatives Considered

Have you considered any alternative solutions or features?

Possibly have smaller runbooks and use the runbook links block

Additional Context

  • Priority: How important is this feature to your workflow? (Low)
  • Frequency: How often would you use this feature? (Daily)
  • Team Impact: I think everyone would find this useful 🤷

Related Issues/Discussions

Link any related issues, discussions, or community conversations about this feature.

Implementation Notes

If you have technical suggestions or constraints to consider, share them here.

Example of what I mean: see the table of contents heading links on a wikipedia page: https://en.wikipedia.org/wiki/Table_of_contents

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions