Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 2.4 KB

readme.md

File metadata and controls

32 lines (25 loc) · 2.4 KB
Raw

Devless Official Bible 📘

Devless is an open source backend as a service for mobile web and IOT application developers to rapidly develop their backend services and generate api endpoints with ease. You can check it out @ Devless

**Documentation Format **

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Content strucuture: Devless seeks to make building software applications really easy and this shouldn't come at the cost of going through every part of the documentation. The structure below is put in place to make looking up specific topics a breeze.

  • The top of the document must have the title written out boldly (# in markdown)
  • You must have on the next line hyperlinked content menu.
  • The parts of the documentations must have a heading or title (## markdown ) without hyperlinks.
  • Any references used within the documentation body must have a reference to the original part of the documentation.
  • You may get started with the structure of the documentation using the sample.md

Rules:

  • links must be provided to external tools used in demonstrations and descriptions.
  • keywords may be highlighted to emphasis.
  • Any tool introduced that has nothing to do with Devless must be stated as such and clearly made known to the reader that is based on opinions and or preference.

Highlighting

  • Use highlights to emphasis.

Hyperlinking

  • Should be used primarily for moving across the documentation
  • You must add an hyperlink reference to your doc file within the documentation markdown, this is used in the sidebar of the documentation renderer to provide easy navigation to users of the doc Context and Addressing
  • As the writer of the documentation you must try as much as possible to clearly state your intentions and provide complete and comprehensive demonstrations.
  • Readers of the documentation may be addressed with the pronoun "you"
  • A writer may address him or her self as "we" and only identifying one's self where necessory.

NB: : Most parts of the this doc is subject to change over time so carefully review before commiting to the documentation is imperative.