Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (47 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 1.6 KB

Contributing to WarDragon Documentation

Thank you for your interest in improving the WarDragon documentation!

How to Contribute

Reporting Issues

If you find errors, unclear instructions, or missing information:

  1. Open an issue on GitHub
  2. Describe what's wrong or missing
  3. Include which document and section
  4. Suggest improvements if possible

Submitting Changes

  1. Fork the repository
  2. Create a branch for your changes
  3. Make your edits
  4. Submit a pull request

Documentation Guidelines

Style

  • Use clear, concise language
  • Write for technical users but don't assume expertise
  • Include code examples where helpful
  • Use tables for structured information
  • Include diagrams for complex concepts (ASCII art or images)

Structure

  • Each document should have a clear purpose
  • Use consistent heading hierarchy
  • Include "Related Documentation" links
  • Add troubleshooting sections where relevant

Formatting

  • Use Markdown formatting
  • Code blocks should specify language for syntax highlighting
  • Tables should be properly aligned
  • Links should use relative paths within the docs

Adding Video Tutorials

If you've created a WarDragon tutorial video:

  1. Edit docs/tutorials/video-index.md
  2. Add your video to the appropriate section
  3. Include:
    • Video title
    • Brief description
    • YouTube/platform link
    • Your channel name

Content Areas Needing Help

  • Additional troubleshooting scenarios
  • Integration guides for other platforms
  • Translation to other languages
  • Video tutorials

Questions?

Join the DragonOS Discord community for discussion and questions.