Skip to content

Commit

Permalink
Fix broken links (#1461)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: sabine <sabine@users.noreply.github.com>
Co-authored-by: Masanori Ogino <omasanori@users.noreply.github.com>
  • Loading branch information
3 people authored and Cuihtlauac ALVARADO committed Aug 31, 2023
1 parent 575b0ab commit 7f8de3b
Show file tree
Hide file tree
Showing 17 changed files with 51 additions and 51 deletions.
2 changes: 1 addition & 1 deletion data/academic_institutions/Beira.md
Expand Up @@ -19,7 +19,7 @@ courses:
- name: Proof and Programming Theory
online_resource: "https://www.di.ubi.pt/~desousa/TPP/tpp.html"
- name: Software Reliability and Security
online_resource: "https://www.di.ubi.pt/~desousa/CF/confia.html"
online_resource: "https://www.di.ubi.pt/~desousa/Ciencia/"
location:
lat: 40.2779
long: -7.5090
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/Boston.md
Expand Up @@ -8,7 +8,7 @@ continent: North America
courses:
- name: Computer Science I
acronym: CS1101
online_resource: "https://www.cs.bc.edu/~muller/teaching/cs1101/s16/"
online_resource: "http://www.cs.bc.edu/~muller/teaching/cs1101/s16/"
location:
lat: 42.3355
long: -71.1685
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/caltech.md
Expand Up @@ -7,7 +7,7 @@ logo: academic_institution/caltech.png
continent: North America
courses:
- name: Fundamentals of Computer Programming
online_resource: "https://users.cms.caltech.edu/~mvanier/"
online_resource: "http://users.cms.caltech.edu/~mvanier/"
location:
lat: 34.1377
long: -118.1253
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/innsbruck.md
Expand Up @@ -8,7 +8,7 @@ continent: Europe
courses:
- name: Programming in OCAML
acronym: SS 06
online_resource: https://cl-informatik.uibk.ac.at/teaching/ss06/ocaml/schedule.php
online_resource: http://cl-informatik.uibk.ac.at/teaching/ss06/ocaml/schedule.php
location:
lat: 47.2692
long: 11.4041
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/maryland.md
Expand Up @@ -8,7 +8,7 @@ continent: North America
courses:
- name: Organization of Programming Languages-(along with Ruby, Prolog, Java)
acronym: CMSC 330
online_resource: "https://www.cs.umd.edu/class/fall2014/cmsc330/"
online_resource: "https://github.com/umd-cmsc330"
location:
lat: 38.9869
long: -76.9426
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/mcgill.md
Expand Up @@ -8,7 +8,7 @@ continent: North America
courses:
- name: Programming Languages and Paradigms
acronym: COMP 302
online_resource: "https://www.cs.mcgill.ca/~bpientka/cs302/"
online_resource: "https://www.mcgill.ca/study/2023-2024/courses/comp-302"
location:
lat: 45.5048
long: -73.5772
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/pennsylvania.md
Expand Up @@ -8,7 +8,7 @@ continent: North America
courses:
- name: Compilers
acronym: CIS341
online_resource: "https://www.cis.upenn.edu/~cis341/current/"
online_resource: "https://www.seas.upenn.edu/~cis3410/current/"
- name: Programming Languages and Techniques I
acronym: CIS120
online_resource: "https://www.seas.upenn.edu/~cis120/current/"
Expand Down
2 changes: 1 addition & 1 deletion data/academic_institutions/rennes.md
Expand Up @@ -2,7 +2,7 @@
name: University of Rennes 1
description: >
The University of Rennes 1 is a public university located in the city of Rennes, France. It is under the Academy of Rennes.
url: "https://international.univ-rennes1.fr/en/welcome-universite-de-rennes-1"
url: "https://www.univ-rennes.fr/"
logo: academic_institution/reness.png
continent: Europe
courses:
Expand Down
Expand Up @@ -12,7 +12,7 @@ language: french
isbn: "2-84177-121-0"
links:
- description: Read Online
uri: https://www.pps.jussieu.fr/Livres/ora/DA-OCAML/index.html
uri: https://www-apr.lip6.fr/~chaillou/Public/DA-OCAML/
- description: Order at Amazon.fr
uri: https://www.amazon.fr/exec/obidos/ASIN/2841771210
featured: false
Expand Down
Expand Up @@ -10,6 +10,6 @@ language: french
isbn: "978-2-916466-05-7"
links:
- description: Order Online from Paracamplus
uri: https://paracamplus.com
uri: https://www.decitre.fr/livres/programmation-de-droite-a-gauche-et-vice-versa-9782916466064.html
featured: false
---
14 changes: 7 additions & 7 deletions data/changelog/odoc/2021-10-06-odoc-2.0.0.md
Expand Up @@ -65,7 +65,7 @@ This release has been a long time coming -- years! -- and contains several notab

The internal library used by `odoc` that models the OCaml module system has been completely rewritten over a multi-year effort by @jonludlam and @Julow, according to a design by @lpw25. The rewrite gives `odoc` a much better understanding of the module system compared to the original implementation. This library is used for two main processes:

1. To perform _expansions_, which is the process where `odoc` takes complex module type expressions like [this one from tyxml](https://ocaml.github.io/odoc/deps/tyxml/Html_f/index.html#module-Make):
1. To perform _expansions_, which is the process where `odoc` takes complex module type expressions like [this one from tyxml](https://web.archive.org/web/20211208100141/https://ocaml.github.io/odoc/deps/tyxml/Html_f/index.html#module-Make):
```ocaml=
module Make
(Xml : Xml_sigs.T with type ('a, 'b) W.ft = 'a -> 'b)
Expand All @@ -74,7 +74,7 @@ module Make
with type +'a elt = Xml.elt
and type +'a attrib = Xml.attrib
```
Then turns it into an [output page](https://ocaml.github.io/odoc/deps/tyxml/Html_f/Make/index.html) containing the correct types, values, modules, includes, and documentation.
Then turns it into an [output page](https://web.archive.org/web/20211208100141/https://ocaml.github.io/odoc/deps/tyxml/Html_f/index.html) containing the correct types, values, modules, includes, and documentation.

2. To perform *resolutions*, which is where `odoc` handles complex paths found in OCaml source in order to calculate the correct definition link. For example, in the following snippet:

Expand All @@ -93,7 +93,7 @@ type t = C.N.t

resolution is the process by which `odoc` determines which documentation page to take you when you click on `C.N.t`.

The new model has logic to handle many features of the OCaml language, as can be explored [here](http://ocaml.github.io/odoc/features.html).
The new model has logic to handle many features of the OCaml language, as can be explored [here](https://web.archive.org/web/20211208094857/http://ocaml.github.io/odoc/features.html).

A particularly important improvement is in handling canonical modules (explained in the link above). The upshot of this is that there should never be any more odd double underscores leaking into your docs!

Expand All @@ -110,23 +110,23 @@ We look forward to many new renderers being created for the varied use cases pre
### Output Structure

`odoc 2.0` introduces a new mechanism to specify the structure of the files produced. Although it's a relatively simple new feature, it nevertheless has enabled `odoc` to be used in new ways. In particular, it has allowed `odoc` to construct the
package documentation for the new OCaml website, [v3.ocaml.org](https://v3.ocaml.org/packages). There is also an [example driver](https://ocaml.github.io/odoc/driver.html), showing how `odoc` can be used to construct a stand-alone website for an OCaml package that contains fully-linked documentation for a package and all of its dependencies. This has been used to create `odoc`'s [new website](https://ocaml.github.io/odoc).
package documentation for the new OCaml website, [v3.ocaml.org](https://v3.ocaml.org/packages). There is also an [example driver](https://web.archive.org/web/20211208094857/https://ocaml.github.io/odoc/driver.html), showing how `odoc` can be used to construct a stand-alone website for an OCaml package that contains fully-linked documentation for a package and all of its dependencies. This has been used to create `odoc`'s [new website](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/).

### New Drivers

Like the OCaml compiler itself, running `odoc` on your code requires careful sequencing of the invocations to produce the correct result. Fortunately both `dune` and `odig` understand how to do this, so most users don't need to know the details. If you want more than these tools provide though, we've written a simple [reference driver](https://ocaml.github.io/odoc/driver.html), documenting exactly what's necessary to use `odoc` to produce rich documentation. A more complete (and more complex) example is the tool [voodoo](https://github.com/ocaml-doc/voodoo), which is being used to create the docs for [v3.ocaml.org](https://v3.ocaml.org/packages).
Like the OCaml compiler itself, running `odoc` on your code requires careful sequencing of the invocations to produce the correct result. Fortunately both `dune` and `odig` understand how to do this, so most users don't need to know the details. If you want more than these tools provide though, we've written a simple [reference driver](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/driver.html), documenting exactly what's necessary to use `odoc` to produce rich documentation. A more complete (and more complex) example is the tool [voodoo](https://github.com/ocaml-doc/voodoo), which is being used to create the docs for [v3.ocaml.org](https://v3.ocaml.org/packages).

## [v3.ocaml.org](https://v3.ocaml.org)

As previously posted, the new version of the OCaml website has been under development for some time now, and an important new feature is the integration of package listings, including documentation for every version of every package. More has been written about this elsewhere, but it's important to note that the new OCaml.org website required a preview version of `odoc 2.0` to work. We've made a few bug fixes since then, so we will update the pipeline to use the released version very soon. For more info on the pipeline to build the docs, see [our recent talk](https://watch.ocaml.org/videos/watch/9bb452d6-1829-4dac-a6a2-46b31050c931) at this year's OCaml Workshop.

## New Website

The website for `odoc` has been improved with guides for [documentation authors](https://ocaml.github.io/odoc/odoc_for_authors.html), [integrators](https://ocaml.github.io/odoc/driver.html), and [contributors](https://ocaml.github.io/odoc/contributing.html). This site is intended to grow over time with more content to help people write docs for their packages.
The website for `odoc` has been improved with guides for [documentation authors](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/odoc_for_authors.html), [integrators](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/driver.html), and [contributors](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/contributing.html). This site is intended to grow over time with more content to help people write docs for their packages.

## OCamldoc?

This release, particularly because of the new output renderers, puts `odoc` in a place where it supercedes OCamldoc in most respects. There are a few features we're missing (see [the comparison](https://ocaml.github.io/odoc/ocamldoc_differences.html) in the docs), including
This release, particularly because of the new output renderers, puts `odoc` in a place where it supercedes OCamldoc in most respects. There are a few features we're missing (see [the comparison](https://web.archive.org/web/20211208101345/https://ocaml.github.io/odoc/ocamldoc_differences.html) in the docs), including
most notably that we don't render the source (OCamldoc's `--keep-code` argument), and that there is no support for custom tags. If `odoc` is lacking features that you're currently relying on in OCamldoc, we'd love to hear from you!

## More Docs!
Expand Down
Expand Up @@ -2,7 +2,7 @@
name: American Museum of Natural History
description: >
The Computational Sciences Department at the AMNH has been using OCaml for almost a decade in their software package POY for phylogenetic inference
url: "https://www.amnh.org/our-research/computational-sciences"
url: "https://www.amnh.org/research/computational-sciences"
logo: users/amnh.png
locations:
- United States
Expand Down
2 changes: 1 addition & 1 deletion data/industrial_users/cacaoweb.md
Expand Up @@ -2,7 +2,7 @@
name: CACAOWEB
description: >
Cacaoweb is developing an application platform of a new kind. It runs on top of our peer-to-peer network, which happens to be one of the largest in the world
url: "https://cacaoweb.org/"
url: "http://cacaoweb.org/"
logo: users/cacaoweb.png
locations:
- United Kingdom
Expand Down
2 changes: 1 addition & 1 deletion data/industrial_users/kernelize.md
Expand Up @@ -4,7 +4,7 @@ description: >
Kernelyze has developed a novel approximation of two-variable functions
that achieves the smallest possible worst-case error among all rank-n
approximations.
url: "https://kernelyze.com/"
url: "https://github.com/kernelyze/kernelyze-base"
logo: users/kernelyze-llc-logo.png
locations:
- United States
Expand Down
4 changes: 2 additions & 2 deletions data/workshops/2009.md
Expand Up @@ -16,15 +16,15 @@ presentations:
- title: Cameleon/Chamo
authors:
- Maxence Guesdon
link: http://home.gna.org/cameleon/chamo.en.html
link: https://web.archive.org/web/20100301000000*/http://home.gna.org/cameleon/chamo.en.html
- title: Delimited overloading
authors:
- Christophe Troestler
link: http://pa-do.forge.ocamlcore.org/
- title: OCaml as fast as C!
authors:
- Sylvain Le Gall
link: https://github.com/ocaml/ocaml.org/blob/master/site/meetings/ocaml/2009/slides/OCamlAsFastAsC.pdf
link: https://github.com/ocaml/v2.ocaml.org/blob/master/site/meetings/ocaml/2009/slides/OCamlAsFastAsC.pdf
- title: VHDL symbolic simulation in OCaml
authors:
- Florent Ouchet
Expand Down

0 comments on commit 7f8de3b

Please sign in to comment.