Documentation Standards

Collaborative documentation rules, writing standards, and contribution guidelines for wiki.code.

Start Contributing 🚀

How to Contribute

1. Write Your Content

Create markdown documentation with clear headings, examples, and explanations. Follow the style guide below.

2. Submit a Pull Request

Fork the repository, add your content in the /content folder, and submit a PR.

3. Review and Publish

Our team will review your contribution for accuracy, style, and completeness. Upon approval, your documentation will be published.

Style & Format Guide

Markdown Standards

  • Use 3 dashes for horizontal lines
  • Code blocks must include language specifiers
  • Keep headings (##, ###) under 70 characters
  • Use semantic headings: #, ##, ###, etc.

Visual Design

  • Responsive layouts with Tailwind CSS
  • SVGs for all icons and diagrams
  • No external libraries in documentation
  • Use code samples for technical content

Code of Conduct

All wiki.code contributors must follow these principles:

  • Be respectful in technical discussions
  • Cite sources for technical claims
  • Flag outdated or incorrect information

Violations may result in content removal and contributor access suspension.

Need Help?

Stuck?

Join our contributor Slack channel for help with documentation formatting and technical questions.

Slack Invite

Found an Error?

Submit an issue in the GitHub repository or use the "Report Problem" button in documentation articles.

GitHub Issues

Want to Report Abuse?

Email abuse@wiki.code with details about harmful content.

Reporting Guidelines