Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.5 KB

File metadata and controls

65 lines (40 loc) · 1.5 KB

Documentation Guidelines


Latest Release Information

This documentation is maintained for REChain version 4.1.10+1160, released on 2025-12-06. Please ensure all documentation updates correspond to this release.

For detailed release notes, see RELEASE_NOTES.md.


Purpose

This document outlines best practices for contributing and maintaining REChain documentation to ensure clarity, consistency, and quality.


Writing Style

  • Use clear, concise language.
  • Write in active voice.
  • Use consistent terminology.
  • Avoid jargon unless defined.
  • Use Markdown formatting for headings, lists, code blocks, and links.

Structure

  • Start with an overview or summary.
  • Use headings and subheadings to organize content.
  • Include examples and code snippets where applicable.
  • Provide links to related documents and resources.

Contribution Process

  • Fork the repository and create a feature branch.
  • Make changes with clear commit messages.
  • Submit a pull request referencing related issues.
  • Participate in code review and address feedback.

Review and Approval

  • Documentation changes are reviewed by maintainers.
  • Ensure accuracy and completeness.
  • Verify links and formatting.

Tools and Resources

  • Use Markdown linters and spell checkers.
  • Preview changes locally or via GitHub.
  • Refer to existing documentation for style consistency.

Contact

For questions or assistance, contact the documentation team at support@rechain.network.