CARINA OS is a collaborative project. This guide explains how to contribute documentation, code, and improvements.
- Identify a gap — Find a topic that needs documentation or improvement
- Log in to the wiki — Use your editor credentials
- Create or edit a page — Follow the page template below
- Follow the style guide — See guidelines below
- Cross-link — Reference related pages
Every technical page should include these sections:
# Page Title
## Overview
What this is and why it matters.
## Prerequisites
What the reader needs before starting.
## Steps
Step-by-step instructions with command examples.
## Validation
How to verify the steps worked.
## Troubleshooting
Common issues and solutions.
## Related Pages
Links to related documentation.
- Ops manual tone — direct, professional, actionable
- Write instructions as commands, not suggestions
- Short sections with clear headings
- Use "what this does" and "why this matters"
- Command examples in fenced code blocks with language tags
- Tables for structured information
- Bullet lists for features and options
- Numbered lists for sequential steps
- Marketing fluff or promotional language
- Overly casual tone
- Undocumented assumptions
- Long paragraphs without structure
- Screenshots without alt text or descriptions
¶ Screenshot Standards
When including screenshots:
- Use PNG format
- Capture only the relevant area
- Include a caption describing what is shown
- Ensure text is readable at normal zoom
| Term |
Usage |
| CARINA |
Always uppercase. Full form: "CARINA OS" in formal contexts |
| FlightDeck |
One word, camelCase |
| MissionLab |
One word, camelCase |
| sandbox |
Lowercase when referring to the feature generically |
| profile |
Lowercase when referring to the concept |
- Navigate to the page you want to edit
- Click the edit button (pencil icon)
- Make your changes in the Markdown editor
- Add a meaningful description of your changes
- Click Save
Contact an administrator to request Editor access. Provide:
- Your name
- Your email address
- Your role (contributor, maintainer, reviewer)
Related: Roadmap, Administration