To keep ObsidianOS documentation helpful and consistent, contributors should follow these guidelines:
- Be informative: Ensure that instructions, explanations, and examples are clear and accurate.
- Consistency is key: Follow the existing formatting, structure, and style. Use markdown headings, code blocks, and lists consistently.
- 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.