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

Add Best Known Methods #107

Merged
merged 28 commits into from Sep 22, 2021
Merged

Add Best Known Methods #107

merged 28 commits into from Sep 22, 2021

Conversation

tmattio
Copy link
Collaborator

@tmattio tmattio commented Sep 22, 2021

This PR adds the Best Known Methods data and includes them on the Best Practices page.

The design is not final, I'll work on this in a follow-up PR.

* Add a link to the Lists tutorial in the index page

* Replace template variable in markdown
patricoferris pushed a commit to patricoferris/v3.ocaml.org-server that referenced this pull request Sep 22, 2021
Copy link
Contributor

@patricoferris patricoferris left a comment

Choose a reason for hiding this comment

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

Apologies for the seemingly large review 🙈 ... most comments are just Opam -> opam! After fixing some of these typos this looks good to add as an initial set of BKMs, thanks :))

@@ -140,7 +140,7 @@ val hello : unit -> unit

(note the double asterisk at the beginning of the comment - it is a good habit
to document .mli files using the format supported by
[ocamldoc](/releases/{{! get LATEST_OCAML_VERSION_MAIN !}}/htmlman/ocamldoc.html))
[ocamldoc](/releases/4.12.0/htmlman/ocamldoc.html))
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm guessing once we have releases we could point this to /releases/latest which redirects to the latest release we have?

data/workflows/en/03_update_deps.md Outdated Show resolved Hide resolved
data/workflows/en/03_update_deps.md Outdated Show resolved Hide resolved
data/workflows/en/04_update_dev_deps.md Show resolved Hide resolved
data/workflows/en/05_select_compiler.md Outdated Show resolved Hide resolved
data/workflows/en/01_bootstrap_project.md Outdated Show resolved Hide resolved
data/workflows/en/01_bootstrap_project.md Outdated Show resolved Hide resolved
data/workflows/en/02_install_deps.md Outdated Show resolved Hide resolved
data/workflows/en/02_install_deps.md Outdated Show resolved Hide resolved
data/workflows/en/02_install_deps.md Outdated Show resolved Hide resolved
tmattio and others added 25 commits September 22, 2021 21:45
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
@tmattio tmattio merged commit 543356c into main Sep 22, 2021
@tmattio
Copy link
Collaborator Author

tmattio commented Sep 22, 2021

Thanks a lot for the thorough review @patricoferris!!

@tmattio tmattio deleted the bkm branch September 22, 2021 20:00
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.

None yet

2 participants