doc: reorganize documentation structure.

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

doc: reorganize documentation structure. #54

Closed demeringo closed 2 years ago

demeringo commented 2 years ago

See #53 for doc structure update
start a basic tutorial
fix a couple of typos
add logos in doc
add logo on the readme
reorganise the readme (usage before development)

demeringo commented 2 years ago

Hi @da-ekchajzer, please check this updated version of the doc and tell me if it looks good to you ;-)

demeringo commented 2 years ago

@odelcroi I realize you are also working on the doc, so I add you to the PR and conversation.

da-ekchajzer commented 2 years ago

Thumbs up for the contrib' !

As you said, doc is always a work in progress, but this is a great enhancement of what has already been done. Indeed, diataxis framework is a great way to organize documentation, seeing it in our context confirms it. Tutorial part with curl is also a great idea to test the api easily, without having to install anything.

I will push a commit tomorrow with one or two corrections on the tutorial part before merging the PR.

Anyway, thank you for the contribution