Document Guidelines

This document itself is part of an open source project and, thus, improvable by community contributions. It intends to provide the basic structure to create a proper Wiki page with quality that allows further revision for content quality and relevance.

To contribute, you can open an issue with your concerns or make a pull request.

About content

First of all content must be relevant. For ensuring this we have created a set of sections:

• Apps development. This section gathers all the documentation relative to the inner workings of an app: How it should be developed in order to get loaded and serve from a router and so how should be structured to be accepted on the marketplace. It should contain further information on how to use IoT resources programatically, perform efficient M2M communications and concatenate events.
• Operative System Design. Documents on how the NetBeast routers works, which packages should be installed, how to make profit of ROM and how to manage security or load applications onto runtime, assign resources etc. It also reflects the design of the dashboard app (Edit in the future to link dashboard repo).
• Hardware compatibility chapter is a list of hardware that is enabled to run NetBeast dashboard and how to make it work. Not only that but how to employ wireless technologies through node.js and configure it into the router OS.
• Guides. Here should be gather how the tweaks in other sessions are performed. This should be useful not only for NetBeast projects, but also for server setups and configurations. This chapter comprehends tutorials and should be written with an open view, not restricted to the environment (OS, architecture, etc) so they have universal character.
• Examples and Developer Stories should give insight to new developers about what is possible within the NetBeast projects.

Document Structure

All documents must include:

1. Briefing to know what is it about. Motivations if they are particularly relevant.
2. Graphic assets or previews if they are suitable. It is better to see the result in order understand what is the document for.
3. Body that encloses the information that is relevant to the section. Code samples must be linked to their corresponding repo document if existing.
4. How to collaborate or make further advance in that direction. Pull requests must be asked to the reader if there is something that might be improved.
5. Contact with the fields in the contact section below
6. References which tutorials or info have been followed.

They also should be as short and concrete as possible and gather a unit of information. If you feel that something is fuzzy, invite readers to conversation in gitter!

About code

For readability we chose a most modern and responsible standard. No semicolons. Least possible opinionated. It shares characteristics widely used by numerous famous javascript projects and has Atom and Sublime Text compatible plugins.

When done writing a document, add its link to the side bar index.

An index should also soon be included in main README.md of all NetBeast repos.

## Contact * Visit our site [https://netbeast.co](https://netbeast.co) * Mail us: staff [at] netbeast.co * Report a bug or enter discussion at [issues](https://github.com/netbeast-co/docs/issues) * Other resources: [Dashboard](https://github.com/netbeast-co/dashboard), Netbeast [API](https://github.com/netbeast-co/API)

🍺 And try not to write too much while drunk