Skip to content

Update documentation guidelines #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
corporate-gadfly merged 3 commits into from
May 22, 2026
Merged

Update documentation guidelines #243

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1a7eac
Update documentation guidelines
tuxmea May 22, 2026
b7997ee
Fix wording for OpenVox
tuxmea May 22, 2026
47d6920
Update CONTRIBUTING.md
tuxmea May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ The site is available at `http://localhost:4000`. Navigation changes require upd

## Writing guidelines

### Naming of OpenVox and Puppet

- `OpenVox` is used when referring to the community implementation of `Puppet` DSL
- `Puppet` is used when describing the underlying DSL or the ecosystem as a whole

Use the following terms for the individual components:

- OpenVox Server
- OpenVoxDB
- OpenFact
- OpenBolt

### Writing and editing pages

- Prefer editing existing pages over creating new ones
Expand Down Expand Up @@ -73,3 +85,11 @@ The site is available at `http://localhost:4000`. Navigation changes require upd

- File names and paths: `monospace`
- Commands and code: `monospace`; short commands inline, longer blocks in fenced code blocks with a language identifier (`bash`, `yaml`, `text`, etc.)
- Use `command` language identifier in favor of `shell`

### Linking

- Don't use URI for links pointing to files form this documentation
- Use URI when referring to remote locations
- Use absolute paths when pointing to files from other sections
- Use filename only without path when referring to a file in the same directory