WIP Docs/rewrite readme#147
WIP Docs/rewrite readme#147arthur91f wants to merge 8 commits intofeat/A134-implement-different-depsfrom
Conversation
half-shell
left a comment
half-shell
left a comment
There was a problem hiding this comment.
Nice draft! The more documentation files I see, the more I'm thinking we should really get some kind of documentation system 😉
That could also get us a first step towards a website for exeiac as well
README.md
Outdated
| To understand this page it's sufficient. But if you want to understand deeper | ||
| the genious idea behind that concept, how many type of dependencies exist | ||
| between your bricks and all element that compose your brick (code description, | ||
| input, ouput, events, trigger, command), I let you read that [page](./docs/brick_concept_and_dependencies) |
There was a problem hiding this comment.
Small phrasing changes 🙄
| To understand this page it's sufficient. But if you want to understand deeper | |
| the genious idea behind that concept, how many type of dependencies exist | |
| between your bricks and all element that compose your brick (code description, | |
| input, ouput, events, trigger, command), I let you read that [page](./docs/brick_concept_and_dependencies) | |
| This summary should be enough for you to be able to read the following paragraphs | |
| and have a basic understanding of exeIaC. | |
| But if you want to get a better grasp at the brick concept itself and its genius simplicity | |
| you can fin a deeper insight on [this documentation page](./docs/brick_concept_and_dependencies). |
README.md
Outdated
| input, ouput, events, trigger, command), I let you read that [page](./docs/brick_concept_and_dependencies) | ||
|
|
||
| ## Get started | ||
| ## Get started and how it works summary |
There was a problem hiding this comment.
| ## Get started and how it works summary | |
| ## Get started |
I think this is still just a get started paragraph.
The ideal case here would be to have a ## tutorial section or file with an actual step by step with a toy infrastructure and the content of the files so a user can get an actual running project to play with. Basically a more involved guide than what already is in howto_write_configuration_file. (c.f. a tutorial's purpose and the 4 types of doc)
If you provide me with a simple running project, I can gladly draft something for you 🙂
2 participants
No description provided.