search

deislabs / hippo-docs

Website for Hippo
https://docs.hippofactory.dev/
Other
2 stars 8 forks source link

Style guide for referencing binaries, code artifacts, and env vars #5

Open technosophos opened 3 years ago

technosophos commented 3 years ago

The text inconsistently uses styles for referencing code-ish artifacts. Sometimes env vars are left unstyled. Sometimes they are stilled. Frequent conventions elsewhere suggest that using a CODE style is appropriate. Similarly, binary names and URLs should have consistent styling.

bacongobbler commented 3 years ago

partially fixed in #11. Some sections like the howto guide and the topic guides need updating.