Everybody at Octopus writes whether it’s documentation, blog posts, CLI help text, marketing copy, pitches, support emails, or text within the product itself. This guide is a quick reference for the conventions we use at Octopus, and a resource to keep us consistent whenever we’re unsure how to write or structure a piece of text.
The style guide includes the following sections:
The easiest way to contribute to this guide is to raise a PR in the repo with the changes or additions you’d like to see added to the guide.
This guide is a simple Jekyll site. The main content pages are written in Markdown and are located in the _pages directory.