Introduce cookbook documentation #1826
Conversation
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
5 times, most recently
from
9cc6c95
to
cfeb25a
Compare
|
I'll review tomorrow or tuesday in depth.. but the overall mood: i love it ! |
There was a problem hiding this comment.
As we will add new images / assets more and more, we'll need some tools to normalize image compression + thumbnails.. at least, in the first weeks/monthes, some "process" to manage files before pushing them.
I'll manually work on this one, but when we have time i think some cli tool / command, or maybe a github action, would be a nice addition ! WDYT ?
The other question i'm not sure about is: how many images do we accept ? As we discussed already about the LiveMemory, we do not want the repository to be 1To in a year. Because every media will add to the repository global size, having an impact on the DX for anyone wanting to open a PR.
BUT i'm really the first one to say it's best/easier for us to have images in the repo, so maybe set some "conventions" about it ? I don't know...
Other point of attention concerns the image rights: any file/media we add there must be releasable under the MIT Licence of this repository: how do we check/enforce this ?
There was a problem hiding this comment.
Yes completely true! I think we need to find a way to manage images for the website. This out of scope for this PR but this really something we should think about!
|
It's a bit related to the PR #1347? |
A bit .. but the "recipe" term refer to a "cookbook recipe" more than a "component recipe" :) |
There was a problem hiding this comment.
I love this @WebMamba!
I'm thinking, accross the board, we should use the term "cookbook" to not be confused with the future "recipes" idea.
For the markdown, take a look at the front matter extension. I think this could be leveraged here.
|
How do you want to proceed @WebMamba here ? Do we review both content / feature here ? Or you prefer just the "code" part for now maybe ? |
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
from
f9f819e
to
74fd42d
Compare
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
from
74fd42d
to
4552ab1
Compare
|
@smnandre lets focus on the code at first, and then on the content. Even if we do that in two times, I can keep the content of the recipe on this PR, I think it's better if we launch the cookbook with a first article. @kbond thanks, I use the front matter extension now, this is pretty cool! @codisart thanks for your review I applied your fix! |
|
As soon as i find 15mn i'll review it i swear 😮💨 |
This PR introduces a new section for the UX website: cookbook. This section aims to give more concrete documentation, show examples of common things implemented with UX components, and go deeper into some concepts that we do in the documentation. The goal is not to replace the documentation but to illustrate
the documentation with concrete examples.
How it's implemented?
Simply by creating a .md file in the recipes directory at the route of the project, then everything is generated automatically. There are cookbook pages that show all the recipes available, then you can click on the recipe to read it.
Who can add recipes to the cookbook?
Anyone! If you thing you implemented something a bit complex but common, just show you did it!
Thank you!
Tell me what you think 😁