ObsidianOS Documentation

The official repository for the documentation of ObsidianOS.

You can view the live documentation here.

---

Documentation Guidelines

To keep ObsidianOS documentation helpful and consistent, contributors should follow these guidelines:

1. Be informative: Ensure that instructions, explanations, and examples are clear and accurate.
2. Consistency is key: Follow the existing formatting, structure, and style. Use markdown headings, code blocks, and lists consistently.
3. Be concise: Provide relevant information without unnecessary verbosity. Avoid redundant explanations.

Tip

When writing documentation:

• Use clear section headers to organize content.
• Include examples, commands, and screenshots where applicable.
• Test instructions before publishing to ensure accuracy.
• Follow Markdown best practices: use proper headings, lists, links, and code blocks.
• Submit pull requests with meaningful commit messages describing your changes.

---

Getting Started

For contributors new to the repository:

1. Fork the repository and clone it locally.
2. Create a new branch for your changes.
3. Make edits and commit with clear messages.
4. Submit a pull request for review.