Skip to content

[editorial] Format doc pages using Prettier? #189

@chalin

Description

@chalin

Might maintainers consider using Prettier to format docs pages? We're happily using Prettier for the OTel website. Advantages, among others:

  • Uniformity in markdown syntax layout
  • We save time and energy by avoiding debates over markdown layout
  • Easier to diff changes to doc pages (because Prettier line-wraps paragraphs --- vs. a single text line per paragraph)

The last point is one of the main advantages IMHO. I was prompted to create this issue following #188.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Need triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions