diff --git a/docs/best-practices/documentation-style-guide.md b/docs/best-practices/documentation-style-guide.md index 7bc1fb086c4d58e4a35e8b101ce318f1808d9457..8a5e5855b4c56e1199dcb11604a04d1cacdc813d 100644 --- a/docs/best-practices/documentation-style-guide.md +++ b/docs/best-practices/documentation-style-guide.md @@ -105,6 +105,10 @@ descriptive names for images. Alternative Text (ALT Tags) should be included for every image. +### Machine-readable symbols + +Machine-readable symbols (e.g. files names, classes, functions, variables, database tables, database columns, commands, etc.) should be formatted either with inline monospace or preformatted code blocks (also in monospace). See the [markdown syntax](/markdownrules/#code) to use for such formatting. + ### URLs Sample links to specific CiviCRM URL paths should use `example.org` as the