Documentation: use output from new doc-ci with odoc 3 features #3123
Conversation
This file contains hidden or 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
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
…d tutorial (ocaml#2909) * Remove section about installing and using tree tool * remove extra newline * Update data/tutorials/getting-started/1_02_your_first_ocaml_program.md * Update data/tutorials/getting-started/1_02_your_first_ocaml_program.md --------- Co-authored-by: sabine <6594573+sabine@users.noreply.github.com> Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>
* fix date format from merlin changelog * changelog and release: OCaml 5.3.0 * Extended highlight description * Arthur Symons' translation of Verlaine verses
* Fix issue 2911 Fix issue ocaml#2911 * Swap sentences --------- Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
* Add load testing utility * Add k6 load testing set up * Update scripts * Use localhost URL for loadtesting This should generally be used for testing capacity locally, not in a live distribution. The latter stresses the actual servers and can lead to your IP being blocked. * Indicate load testing from HACKING.md
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
…caml#2925) This reverts commit 030df65.
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
…ntributions.md file (ocaml#2907) * Update CONTRIBUTING.md PR Template Added * Create PULL_REQUEST_TEMPLATE.md file added * Update CONTRIBUTING.md added PR template section * Update CONTRIBUTING.md updated the OCml Cookbook Recipes Section Added Guidelines for New Recipes. * some rearranging, introducing a PR template selector template --------- Co-authored-by: sabine <6594573+sabine@users.noreply.github.com>
* Survive tailwindcss binary
* When building target specific binary
- If already available in installed world, copy
- If not found, download
- Using %{bin-available} does not work, targets are always available
* Define a package tailwindcss which allows installing tailwindcss in
local switch
* Making tailwindcss survive dune clean:
- dune build tailwindcss.install
- dune install -p tailwindcss
- This does not work if written in dune file. Everything takes place
indide _build
Note: While debugging, doing progn / chmod / copy in tailwindcss rules
made curl happen take place twice.
* Add HACKING note
---------
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
…2938) * enable linking to YouTube videos from conferences pages * fmt
* enable linking to YouTube videos from conferences pages * fmt * (data) add FUN OCaml 2024 information to conferences page
Signed-off-by: Etienne Marais <dev@maiste.fr>
Signed-off-by: Etienne Marais <dev@maiste.fr>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
Co-authored-by: cuihtlauac <1917592+cuihtlauac@users.noreply.github.com>
* (data) add OCaml Platform Newsletter Feb - Apr 2025 * add link to Discuss Forums with CTA to comment
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
It was added in ocaml/odoc#1314 and needs not be ignored Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Odoc 3 allows to have breadcrumbs without href. Currently, the breadcrumbs are still computed by ocaml.org, but soon it will be taken from odoc3's json output. Co-authored-by: Jon Ludlam <jon@recoil.org>
With odoc 3 and hierarchical documentation, breadcrumbs will include pages. They are rendered with `/` between them (while other components are rendered with `.` between them). So We can have `library1/Module.Submodule`. Pages cannot yet happen since we still compute breadcrumbs ourselves. Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Co-authored-by: Jon Ludlam <jon@recoil.org>
Collaborator
|
Thanks @panglesd. Can you rebase on main? Should this be considered a draft? |
Contributor
Author
|
It is already based on main, but the PR targets the I think the idea was to first merge on Would it be fine if I just reopen the PR targeting the I was not sure whether it should be considered as a draft since the parts that are already in the branch are ready for review. |
Collaborator
|
Right now, staging is broken. It's always best to be based on main, even when planning to deploy to staging. Your PR touches many files and has many commits. Both seem unrelated to doc-ci and odoc3. Am I mistaken? If not, rebasing on an up-to-date main may help focus the PR on its matter. |
Merged
4 tasks
Contributor
Author
This PR is already based on an up-to-date I opened #3124 targeting |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
36 participants
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 PR uses the output from the new doc-ci @jonludlam has been working on. The docs are built with odoc 3, benefiting from several features, some of them that were previously "emulated" on this repo (such as a global sidebar).
This currently implements:
This PR is not yet complete, however all pushed commits can already be reviewed, so I think it was already worth opening.
I tried to make the commits as atomic as possible to ease the review, which can then be made "commit by commit". All commits compile, although they may fail at runtime (eg due to wrong format for deserializing).
I'll post updates and warn when I consider the PR complete!
(The branch was based on
main. Should I rebase onstaging, or shouldstagingbe rebased onmain?)