Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API
GNU Affero General Public License v3.0
68 stars 23 forks source link

Update documentation chapters #53

Closed demeringo closed 2 years ago

demeringo commented 2 years ago

Problem

As dicussed in #51 we could update the name of several sections of documentation.

Solution

Apply the following:

  1. [x] rename "FUNCTIONAL" by explanation. I like the fact that there is 0 code nor API request in this section. It's a way to explain our methodology for non developers.
  2. [x] rename "HOW TO" by reference
  3. [x] Create a real "HOW TO" section with real explainable use cases
  4. [x] Today, "TRY IT OUT" is a more condensed documentation than a proper tutorial. We could keep "TRY IT OUT" as an executable steel cheat and create a quick tutorial to fulfill all the goals you have presented.

Also:

  1. [x] group Home and Introduction as a single topic that provides links to other sections.
  2. [x] Move the useffull resources to the reference section.
demeringo commented 2 years ago

Closed through #54