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

Integrate pages from CS3110 and Real World OCaml #1766

Merged
merged 8 commits into from
Dec 7, 2023

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented Nov 15, 2023

This patch adds the following documentation pages:

  • Monads (from CS3110)
  • Memoisation (from CS3110)
  • Memory Representation of Values (Real World OCaml)
  • Understanding the Garbage Collector (Real World OCaml)
  • Compiler Frontend (Real World OCaml)
  • Compiler Backend (Real World OCaml)

The CS3110 excerpts have been minimally edited (formatting changes, see 52200dc), while the Real World OCaml pages have been edited a bit more, specifically on the introduction sections (see 4c59d6a).

  • approved by Anil / Yaron
  • approved by Michael Clarkson

@sabine sabine force-pushed the enable_integration_of_external_tutorials branch from c3cea76 to 31dc0ab Compare November 15, 2023 11:35
Copy link
Collaborator

@cuihtlauac cuihtlauac left a comment

Choose a reason for hiding this comment

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

Only found a dead link. The rest in beautiful.

data/tutorials/language/5rt_00_memory_representation.md Outdated Show resolved Hide resolved
@tmattio tmattio force-pushed the enable_integration_of_external_tutorials branch from 20227b1 to 944329f Compare November 16, 2023 11:51
@sabine sabine force-pushed the enable_integration_of_external_tutorials branch from 2fa6c4f to 84df899 Compare November 20, 2023 15:12
@avsm
Copy link
Member

avsm commented Nov 21, 2023

My bits approved, thanks as always for the wonderful work, @sabine!

@christinerose
Copy link
Collaborator

In li 233 in the garbage collection doc, can this sentence:
"this promotes the weak pointer to the record to a normal
pointer"
be written like this:
"this promotes the weak pointer to a normal pointer's record"

@sabine
Copy link
Collaborator Author

sabine commented Nov 29, 2023

@christinerose these changes need to be proposed upstream, I don't think we should unnecessarily increase the diff here.

ETA: I moved the line editing changes to another branch here: https://github.com/sabine/ocaml.org/tree/line_editing_on_rwo

@sabine sabine force-pushed the enable_integration_of_external_tutorials branch from 9eb92e6 to 74257d4 Compare November 29, 2023 19:45
@sabine sabine force-pushed the enable_integration_of_external_tutorials branch from 74257d4 to c411fa6 Compare December 5, 2023 17:08
@sabine sabine merged commit 61e213b into ocaml:main Dec 7, 2023
3 checks passed
@sabine sabine deleted the enable_integration_of_external_tutorials branch December 7, 2023 08:57
sabine added a commit to balat/ocaml.org that referenced this pull request Dec 12, 2023
* shorten and move old gc tutorial to guides section

* code changes to enable integration of third-party docs

* add CS3110 documents and CS3110 banner
- Memoization
- Monads

* add RWO pages and RWO banner:
- Memory Representation of Values
- Understanding the Garbage Collector
- Compiler Frontend
- Compiler Backend
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants