https://github.com/ocaml/ood
OCaml.org v3 data repository
https://github.com/ocaml/ood
Last synced: 8 months ago
JSON representation
OCaml.org v3 data repository
- Host: GitHub
- URL: https://github.com/ocaml/ood
- Owner: ocaml
- License: other
- Archived: true
- Created: 2021-04-30T15:39:19.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-14T13:10:05.000Z (over 4 years ago)
- Last Synced: 2024-09-30T06:23:50.244Z (over 1 year ago)
- Language: OCaml
- Size: 16.3 MB
- Stars: 14
- Watchers: 8
- Forks: 8
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
❗ **This repository has moved to https://github.com/ocaml/v3.ocaml.org-server. Please open issues and PRs there.**
Typed and Versioned Data for OCaml.org v3
-----------------------------------------
Status: Not yet open for contributions. Contact @avsm.
This repository contains data for the OCaml.org website along with a suite of
tools for managing that data. In particular:
- `data`: stores all of the data. There are two kinds of data, those stored as yaml files and those stored in a jekyll-format (a meta-data section of yaml and a body of markdown). In addition to this the tutorials are also written using [mdx](https://github.com/realworldocaml/mdx) to ensure they are up to date.
- `src`: contains the code for three separate tools.
+ `ood`: is almost exclusively OCaml modules generated by parsing and slightly modifying the `data` stored in this repository.
+ `ood-gen`: contains a suite of CLI tools for generating, parsing and fetching data. For example, `ood-gen/bin/lint.ml` reads all of the different items in `data` and ensures they are correct. This tool is run whenever you run `make test`.
+ `ood-preview`: contains a simple [dream](https://github.com/aantron/dream) server to provide a playground for experimenting with HTML rendering of the data.
For more information about the ocaml.org site, please see the main repository
at and the server at .
If you wish to contribute, we have some [contributing documents](./CONTRIBUTING.md) and plenty of [issues](https://github.com/ocaml/ood/issues).
**Current OCaml Version: 4.10.2** -- in order for the mdx tests to be consistent (for example some list the functions available from the `List` module) you should only run them with the current version of OCaml this repository is using.