-
Notifications
You must be signed in to change notification settings - Fork 392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add a cookbook #10142
Open
emillon
wants to merge
11
commits into
ocaml:main
Choose a base branch
from
emillon:doc-cookbook
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
doc: add a cookbook #10142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Curious to hear your thoughts about this @ElectreAAS |
Signed-off-by: Etienne Millon <me@emillon.org>
Signed-off-by: Etienne Millon <me@emillon.org>
Signed-off-by: Etienne Millon <me@emillon.org>
Signed-off-by: Etienne Millon <me@emillon.org>
emillon
force-pushed
the
doc-cookbook
branch
from
February 28, 2024 15:26
638bd06
to
f104d3f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This creates a "cookbook" section with some self-contained examples.
Theses examples are extracted from
quick-start.rst
.One nice aspect is that these samples are linkable, and that the previous/next links work.
I tried to convert some of the examples to a style that encourages tinkering ("Run it!" / "Change it!" in
hello-world
for example), but most examples are just moved as is.Questions / follow-up work:
/tutorials/cookbook
?cookbook/index
.define-library
), are not formatted (ex:generator
), do not follow best practices (ex:c-stubs
, useless(name)
, no:standard
), or might be useless (toplevel
). This can be addressed separately.examples
directory? should it be moved to the cookbook?