Skip to content

[Feature Request]: Button directive #2373

@theletterf

Description

@theletterf

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

As the only way to display a button in our docs right now is to use classic Markdown link + image syntax and use button images, we could use a way of adding buttons to our docs, either alone or in button groups, linking internally or externally.

I see several use cases for this, including quick install links for certain instrumentations, more visible CTAs in some onboarding docs, and so on, but would love to get your feedback.

Proposed Solution

A directive that allows to add buttons in docs.

Examples and Research

Buttons are used by competitors in docs (exhibits 1, 2, and 3).

How important is this feature to you?

Might be quite important to make docs more actionable.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions