README.md

Reference Documentation

How to use the farming module Reference documentation.

• Reference Documentation
  • Introduction
  • Contributing
  • Layout
  • Reference

Introduction

This section contains Reference documentation for farming module. Reference Documentation is intended to be information-oriented. Content must allow the reader to easily navigate the content and use the content in conjunction with the code.

Contributing

• The content must be dry, clear, and terse in style.
• All documentation should be written following Google Documentation Best Practice
• Generate as much documentation as possible from the code.
• Raise a PR for all documentation changes

Layout

Reference Documentation will come in various forms:

• A record of governance proposals - all signal governance proposals reside related to farming module.

Reference

• Google Style Guide for Markdown
• Write the Docs global community
• Write the Docs Code of Conduct