Description
Extending from onyx-lang/onyx-examples#1
Add a new "Cookbook" living documentation repository that holds the following topics:
-
More complete examples. Maybe porting the examples directory to a markdown format for easier sharing. These are different from the website examples since those are more short, only to demostrate the language instead of full complete examples in the cookbook.
-
Store solutions for Advent of Code in Onyx. Advent of Code is a great way to showcase Onyx since these are common problems that can be compared with many other languages. A well structured and heavily commented solution can be a good reference material.
-
Example implementation of common algorithms and problems solutions and troubleshoot. Example: https://github.com/gleam-lang/cookbook/
-
Hold official articles and tutorials (language tour, writing onyx). The current way is using https://onyxlang.io/docs/guides but is recommended that such articles and tutorials be written separate from the website to improve readability, consistency and allow quicker deployments and corrections.
-
Hold references, comparisons and cheatsheets with other programming languages so is easier for people with different backgrounds to pick up Onyx. Example: https://gleam.run/cheatsheets/gleam-for-elixir-users/
-
Migrate some articles from the Wiki to the Cookbook: https://github.com/onyx-lang/onyx/wiki/Onyx-Type-Info
-
An "Awesome List" of resources of the current Onyx ecosystem. These are more than packages since it can be projects or other related resources. Example: https://github.com/gleam-lang/awesome-gleam
Technology:
- Is recommended to use the same as the official book:
mdbook.
State of the Art
- Onyx Book (https://docs.onyxlang.io/book/Overview.html): The language reference and overview.
- Onyx Examples (https://onyxlang.io/examples): Quick examples to showcase Onyx syntax and capabilities.
- Onyx API (https://docs.onyxlang.io/packages/core): Quick reference for core APIs.