Skip to content

[Docs] Synchronize REST API documentation styling and label order with Meshery docs #1001

@thechillbasu

Description

@thechillbasu

Current State

The REST API documentation in the Layer5 Cloud docs uses an outdated visual style where resource chips and HTTP method badges are both pill-shaped and nearly identical. Additionally, the label order follows a "Verb-Noun" pattern (Method before Resource), which lacks visual distinction and creates inconsistent affordance between interactive and static elements.

Image

Desired State

As asked for by @leecalcote, synchronize the documentation design with the standards established in Meshery Docs (meshery/meshery#18970):

  1. Visual Distinction: Transition resource chips to a "stamp-style" design (reduced border-radius, dashed border, and increased letter-spacing) to differentiate them from method badges.
  2. Label Swap: Swap the label rendering order in the operation headers to a "Noun-Verb" pattern (Resource Chip first, Method Badge second) for better clarity, readability and consistency with the Meshery documentation.
Image

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions