Developer documentation¶

Getting started¶

Clone the repo:

git clone git@github.com:tbitai/ruzsa.git

Install dependencies:

npm install

Build in development mode and start LiveReload development server:

npm run dev

Testing¶

A good general test case is to prove the first exercise from Fitch’s first-order video tutorial (available on the Openproof Courseware website’s video tutorials page):

\[ \begin{align}\begin{aligned}\newcommand{\Tet}{\mathrm{Tet}} \newcommand{\Small}{\mathrm{Small}}\\\begin{split}& ∃x\ \Tet(x) \\ & ∀x\ (\Tet(x) → \Small(x)) \\ & ∴\ ∃x\ \Small(x) \\\end{split}\end{aligned}\end{align} \]

Version bumping¶

Increase "version" in package.json.
Add new section to RELEASES.md, following Keep a Changelog and the conventions of earlier releases’ notes.
git tag new version.

Deploying¶

Build in production mode:

npm run build

Deploy to production…

npm run deploy-production

… or to staging:

npm run deploy-staging

Documentation¶

The documentation is under the docs directory. In the following commands we assume that’s the current directory.

Set up environment according to .readthedocs.yml, installing requirements (Sphinx etc.):

mkvirtualenv ruzsa-docs -p python3.8 -r requirements.txt

Build:

./build_html.sh

Continuous deployment is set up to Read the Docs. On every push to GitHub, deployment is triggered. Two versions are deployed:

/en/stable — the commit with the highest stable (i.e., non pre-release) version tag.
/en/latest — the latest commit on master. This version is hidden, but it can be accessed via the URL (well, or from here 🤓).