docs: Improve style for inline literals and update contrib guidance (e…

…nvoyproxy#16194) Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>
gokulnair · May 6, 2021 · e4eba7c · e4eba7c
1 parent 9a00865
commit e4eba7c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/api/CONTRIBUTING.md b/api/CONTRIBUTING.md
@@ -72,7 +72,6 @@ The following are some general guidelines around documentation.
   // [#comment:TODO(mattklein123): Do something cooler]
   string foo_field = 3;
   ```
-
-* Prefer *italics* for emphasis as `backtick` emphasis is somewhat jarring in our Sphinx theme.
+* Please use *italics* (enclosed in asterisks `*emphasized word*`) for emphasis and `inline literals` for code quotation (enclosed in *double* backticks ` ``code`` `).
 * All documentation is expected to use proper English grammar with proper punctuation. If you are
   not a fluent English speaker please let us know and we will help out.
diff --git a/docs/root/_static/css/envoy.css b/docs/root/_static/css/envoy.css
@@ -28,3 +28,11 @@ table.docutils div.line-block {
 .rst-content .sidebar {
   clear: right;
 }
+
+/* make code.literals more muted - dont use red! */
+.rst-content code.literal {
+    color: #555;
+    background-color: rgba(27, 31, 35, 0.05);
+    padding: 2px 2px;
+    border: solid #eee 1px;
+}