Commit dae3a8b
Add Docusaurus documentation website
Summary:
Sets up a [Docusaurus](https://docusaurus.io/) site under `cinderx/website/` that builds the public CinderX documentation and publishes it to GitHub Pages at https://facebookincubator.github.io/cinderx/.
Migrates the existing developer docs out of `Docs/` (`.rst`/`.md`) and `Jit/` into `website/docs/` as Markdown, organized into JIT Compiler, Static Python, and Strict Modules sections with a hand-authored sidebar (`sidebars.ts`). Any internal docs have been moved into the other internal folder. The docs plugin serves pages at the site root, parses `.md` as CommonMark to avoid MDX surprises, and fails the build on broken internal links so doc rot is caught in CI.
Adds the `.github/workflows/docs.yml` GitHub Actions workflow to build the site on pull requests touching `cinderx/website/` and deploy to GitHub Pages when those changes land on `main`. Updates the top-level OSS `README.md` to link to the published documentation site. The `website/README.md` documents the layout and how to add or edit pages.
open questions:
1. can we purchase the cinderx.com or .org domain name so we dont have to use the github.io url?
2. what do we think about moving the docs into the website folder rather than a top level folder? this is the standard way to organise it with docusaurus
3. I think the performance section is interesting enough to be a page on its own, but for now as we don't have a lot of data I just added it to the intro page (uses the latest stats from the pycon talk)
Reviewed By: DinoV, yangdanny97
Differential Revision: D109353395
fbshipit-source-id: f4802f9f69b0be9b87ea7e925c3639e88fc9a06f1 parent 021efd0 commit dae3a8b
57 files changed
Lines changed: 10579 additions & 1440 deletions
File tree
- .github/workflows
- cinderx
- Docs
- StrictModules
- guide
- conversion
- errors
- limitations
- website
- docs
- Jit
- hir
- StaticPython
- src/css
- static
- img
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
58 | 60 | | |
59 | 61 | | |
60 | 62 | | |
| |||
This file was deleted.
This file was deleted.
Lines changed: 0 additions & 48 deletions
This file was deleted.
Lines changed: 0 additions & 53 deletions
This file was deleted.
This file was deleted.
Lines changed: 0 additions & 42 deletions
This file was deleted.
Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 0 additions & 66 deletions
This file was deleted.
0 commit comments