Minor edits like typo fixes can be made by following the edit link at the bottom of each gradML webpage.
Those with write access to this repository can edit directly via the GitHub webUI; a PR can be another approach. Content edits pushed to the main branch will be "live" on gradML within a few seconds. Other changes, like website infrastructure upgrades or feature changes, require a server-side reload.
Below is a quick demo of adding a "gradient vector" blob (commit c8d8c5d)
The gradML website structure largely mirrors the file system structure (with a few exceptions, detailed later). Every html webpage is sourced from a .md markdown file. Any markdown file with a filename starting with _ or located in a folder whose name starts with _ is skipped and not turned into a webpage, e.g., no files under this _docs folder are rendered on gradML.
Top-level navigational pages are placed in the root folder. For example, the site links to https://gradml.mit.edu/review/ on the homepage since the corresponding source review.md is located in the repo's root folder.
Lower-level structure is declared in the _config.yml file. For example, this blob
- scope:
path: "reinforcement/"
values:
parent: Reinforcement Learning
layout: pagein the _config.yml file tells the site to look for markdown files located in the <repo root>/reinforcement folder to organize the corresponding drop-down module. Similarly, under <repo root>/supervised/, the learnability_and_vc.md file is rendered as the gradml.mit.edu/supervised/learnability_and_vc/ page.