Skip to content
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

Cookbook : encoding #2097

Merged
merged 7 commits into from
Feb 28, 2024
Merged

Cookbook : encoding #2097

merged 7 commits into from
Feb 28, 2024

Conversation

F-Loyer
Copy link
Contributor

@F-Loyer F-Loyer commented Feb 26, 2024

Here is a (charset) encoding/decoding proposal for the cookbook using camomile.

Copy link
Collaborator

@christinerose christinerose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line editing. Fix some subject/verb agreements, etc.

data/cookbook/encoding/encoding/00-camomile.md Outdated Show resolved Hide resolved
data/cookbook/encoding/encoding/00-camomile.md Outdated Show resolved Hide resolved
data/cookbook/encoding/encoding/00-camomile.md Outdated Show resolved Hide resolved
@sabine sabine merged commit 6f5a472 into ocaml:cookbook Feb 28, 2024
1 check was pending
sabine pushed a commit that referenced this pull request Mar 1, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
sabine pushed a commit that referenced this pull request Mar 28, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
cuihtlauac pushed a commit that referenced this pull request Apr 5, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
cuihtlauac pushed a commit that referenced this pull request Apr 16, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
cuihtlauac pushed a commit that referenced this pull request Apr 22, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
cuihtlauac pushed a commit that referenced this pull request Apr 23, 2024
* Prototype OCaml Cookbook

* add a rule to crunch the cookbook directory

* move position of cookbook

* side-by-side code view like Go by Example

* copy to clipboard, random number gen recipe

* hierarchy: category > task > recipe

- URL we serve this under is docs/cookbook/[task slug]/[recipe slug]
- multiple recipes per task
- recipe page displays links to other recipes for the same task

* bring back the styles on the input that I accidentally replaced by 'hidden'

* move cookbook to community section, refactor active_top_nav_item to be controlled by learn_layout.eml and community_layout.eml

* move to Learn area

* Cookbook : encoding (#2097)

* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>

* Cookbook : and Sorting list and arrays (#2098)

* Cookbook: add Sorting

* Update 00-stdlib.md / remove tabs

* Update 00-stdlib.md / remove tabs

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook textprocessing (#2104)

* Cookbook: text processing

* Cookbook: text processing (remove tabs)

* Cookbook: text processing (typo)

* Cookbook: text processing (typo)

* Cookbook: text processing (typo)

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookboot : Add a Database / ezsqlite entry (#2100)

* Cookbook : Database/ezsqlite

* Remove tabs

* Declare packages

* Indent error

* typo

* Update cookbook_categories.yml : fix folder name in cookbook_categories.yml

* Update cookbook_categories.yml - cookbook index fix

* Update 00-ezsqlite.md

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook concurrency : Lwt (#2107)

* Cookbook: add concurrency / Lwt

* Cookbook: add concurrency / Lwt - fix

* Cookbook: add concurrency / Lwt - fix

* Cookbook: add concurrency / Lwt - fix

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook caqti ppx rapper (#2108)

* Cookbook : Caqti and ppx_rapper

* Cookbook : Caqti and ppx_rapper - fix

* Cookbook : Caqti and ppx_rapper - fix

* Cookbook : Caqti and ppx_rapper - @ notation

* add query with WITH clause

* typo WITH/WHERE

* fix

* fix

* fix

* fix

* fix

---------

Co-authored-by: Frederic LOYER <[email protected]>

* simplify data format of cookbook files

* change data format to .ml file with YAML header, comments get displayed side-by-side with the code

* Cookbook Ezsqlite - typo and rewriting (#2119)

Co-authored-by: Frédéric LOYER <[email protected]>

* Cookbook Sorting - typo (#2118)

Co-authored-by: Frédéric LOYER <[email protected]>

* add dark mode styles

* Cookbook : fix in Lwt (type mismatch with iter_s/iter_p functions) (#2127)

* Cookbook : fix in Lwt

* Update 00-lwt.ml

---------

Co-authored-by: Frédéric LOYER <[email protected]>

* Update 00-caqti-ppx-rapper.ml - fix sqlite -> sqlite3 (#2126)

* rearrange category hierarchy and render all recipes for a task, name rercipes based on task and first listed package

* rebase

* add some tasks

* list the task separately in the table and all the recipes below the task

* add aria-label to make clear to screen-readers where the recipe link is going

* Added description field to tasks

* Task pages

* Task description

* Remove str and stdlib recipes

* Cookbook description text

* Formatting

* minor style changes

* Formatting

* Update CONTRIBUTING.md

* Fix tasks.yml processing

* Formatting

* Add Yaml deserializing recipe

* Refactor JSON tasks

* Text and formatting

* Review

* Remove sorting recipe

* Cleanup

* Delete postponed recipes

* Update localtime recipe

* Do not display package versions

* Formatting

* Display used libraries per package

* Display version as tested and category path

* Fix contribution text

* Fixes

* Formatting

* Fix category path

* Formatting

* Refactoring

* Add hl_yaml recipe

* Fix comments

* Formatting

* Formatting

* Review edits

* Fix typo

* Import FS tasks from PR 1400

* Bring back random generation

* Bring back random generation, con't

* Read text and gziped file

* Formatting

* Fix typo

* Formatting

* Remove some recipes

* Rebase

* Make task description optional

* Random values

* Formatting

* line editing CONTRIBUTING.md

---------

Co-authored-by: sabine <[email protected]>
Co-authored-by: Frédéric Loyer <[email protected]>
Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
Co-authored-by: sabine <[email protected]>
Co-authored-by: Cuihtlauac ALVARADO <[email protected]>
cuihtlauac pushed a commit that referenced this pull request Apr 25, 2024
* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
sabine added a commit that referenced this pull request May 6, 2024
* Prototype OCaml Cookbook

* add a rule to crunch the cookbook directory

* move position of cookbook

* side-by-side code view like Go by Example

* copy to clipboard, random number gen recipe

* hierarchy: category > task > recipe

- URL we serve this under is docs/cookbook/[task slug]/[recipe slug]
- multiple recipes per task
- recipe page displays links to other recipes for the same task

* bring back the styles on the input that I accidentally replaced by 'hidden'

* move cookbook to community section, refactor active_top_nav_item to be controlled by learn_layout.eml and community_layout.eml

* move to Learn area

* Cookbook : encoding (#2097)

* Cookbook index : add encoding

* Cookbook encoding typos

* Add dune

* Update 00-camomile.md / remove tab

* Update 00-camomile.md / remove tab

* Update 00-camomile.md

* Apply suggestions from code review

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: Frederic LOYER <[email protected]>
Co-authored-by: Christine Rose <[email protected]>

* Cookbook : and Sorting list and arrays (#2098)

* Cookbook: add Sorting

* Update 00-stdlib.md / remove tabs

* Update 00-stdlib.md / remove tabs

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook textprocessing (#2104)

* Cookbook: text processing

* Cookbook: text processing (remove tabs)

* Cookbook: text processing (typo)

* Cookbook: text processing (typo)

* Cookbook: text processing (typo)

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookboot : Add a Database / ezsqlite entry (#2100)

* Cookbook : Database/ezsqlite

* Remove tabs

* Declare packages

* Indent error

* typo

* Update cookbook_categories.yml : fix folder name in cookbook_categories.yml

* Update cookbook_categories.yml - cookbook index fix

* Update 00-ezsqlite.md

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook concurrency : Lwt (#2107)

* Cookbook: add concurrency / Lwt

* Cookbook: add concurrency / Lwt - fix

* Cookbook: add concurrency / Lwt - fix

* Cookbook: add concurrency / Lwt - fix

---------

Co-authored-by: Frederic LOYER <[email protected]>

* Cookbook caqti ppx rapper (#2108)

* Cookbook : Caqti and ppx_rapper

* Cookbook : Caqti and ppx_rapper - fix

* Cookbook : Caqti and ppx_rapper - fix

* Cookbook : Caqti and ppx_rapper - @ notation

* add query with WITH clause

* typo WITH/WHERE

* fix

* fix

* fix

* fix

* fix

---------

Co-authored-by: Frederic LOYER <[email protected]>

* simplify data format of cookbook files

* change data format to .ml file with YAML header, comments get displayed side-by-side with the code

* Cookbook Ezsqlite - typo and rewriting (#2119)

Co-authored-by: Frédéric LOYER <[email protected]>

* Cookbook Sorting - typo (#2118)

Co-authored-by: Frédéric LOYER <[email protected]>

* add dark mode styles

* Cookbook : fix in Lwt (type mismatch with iter_s/iter_p functions) (#2127)

* Cookbook : fix in Lwt

* Update 00-lwt.ml

---------

Co-authored-by: Frédéric LOYER <[email protected]>

* Update 00-caqti-ppx-rapper.ml - fix sqlite -> sqlite3 (#2126)

* rearrange category hierarchy and render all recipes for a task, name rercipes based on task and first listed package

* rebase

* add some tasks

* list the task separately in the table and all the recipes below the task

* add aria-label to make clear to screen-readers where the recipe link is going

* Added description field to tasks

* Task pages

* Task description

* Remove str and stdlib recipes

* Cookbook description text

* Formatting

* minor style changes

* Formatting

* Update CONTRIBUTING.md

* Fix tasks.yml processing

* Formatting

* Add Yaml deserializing recipe

* Refactor JSON tasks

* Text and formatting

* Review

* Remove sorting recipe

* Cleanup

* Delete postponed recipes

* Update localtime recipe

* Do not display package versions

* Formatting

* Display used libraries per package

* Display version as tested and category path

* Fix contribution text

* Fixes

* Formatting

* Fix category path

* Formatting

* Refactoring

* Add hl_yaml recipe

* Fix comments

* Formatting

* Formatting

* Review edits

* Fix typo

* Import FS tasks from PR 1400

* Bring back random generation

* Bring back random generation, con't

* Read text and gziped file

* Formatting

* Fix typo

* Formatting

* Remove some recipes

* Rebase

* Make task description optional

* Random values

* Formatting

* Locate errors

* line editing cookbook.eml

* Line editing CONTRIBUTING.md

* cannot use tag in prose, plain link instead

* try and improve text on the recipes

---------

Co-authored-by: Thibaut Mattio <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
Co-authored-by: sabine <[email protected]>
Co-authored-by: Cuihtlauac ALVARADO <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants