[Edit] Proposals for DOCUMENTATION_TEMPLATE.md

æpp Development Project Ideas
1

Hey æ people :heart:

As some of you know I’m working on the documentation hub currently and was thinking to develop an appropriate template for our GitHub documentations as we’ve already one for creating issues:https://github.com/aeternity/aeternity/blob/master/ISSUE_TEMPLATE.md

Any feedback is highly appreciated for developing the best template for all of us, which will create a common thread for our GitHub documentation universe in the future!

Happy day!

Pegah

Proposal for DOCUMENTATION_TEMPLATE.md

Table of Contents

  1. …
  2. …
  3. …
    .
    .
    .

Introduction

…

Documentation

…

Getting Started

Prerequisites

  • …
  • …
    .
    .
    .

Installing

  1. …
  2. …
    .
    .
    .

Tools

if it’s existing (for example referring to debugging tools for testing)

Examples

…

Tutorials

…

Possible Future Iterations

…

Community

If you want to report any bugs or have feature requests regarding to this repository, please create an issue for this. If you have any additional questions, please add them in our Forum under the topic FAQ.

2 Likes