envoyproxy / envoyproxy/envoy

Fix inline literals in the docs

Open
#19,634 7 comments 0 reactions 0 assignees View on GitHub
area/docs help wanted linting tech debt
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

Description

### description

historically it was the policy to use single backticks for `inline-literals` in the docs, which has the effect of making them italics.

the correct rst spec for these is to use double-backticks.

i have been cleaning these up in docs i have worked on or in prs i have reviewed but there are still a lot of places that have italicized _inline-literals_

we can probably break this up into fixing different parts of the site - ie api, docs, etc

ideally, once this is fixed we would want it to stay fixed - see #19633 for further discussion of this

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.