📝 Initialise MyST docs

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines the website is served from, including CSS & JS assets
+  # You may need to change this to `BASE_URL: ''`
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install MyST Markdown
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "./_build/html"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

docs/.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+/_build/

docs/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+---
+title: Contribute to the documentation
+short_title: Write Documentation
+---
+
+## Build the documentation locally
+
+To build the documentation:
+
+1. Clone this repository:
+
+   ```bash
+   git clone https://github.com/2i2c-org/unnamed-thingity-thing
+   ```
+
+1. Navigate to the docs folder:
+
+   ```bash
+   cd docs/
+   ```
+
+1. Install the software packages for documentation:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+1. Start a MyST server to preview the documentation:
+
+   ```bash
+   myst start
+   ```
+
+This will build the documentation locally so that you can preview what your changes will look like.

docs/README.md

@@ -0,0 +1,5 @@
+# Docs
+
+This folder contains the source files for the documentation.
+
+See the [contributing guide](CONTRIBUTING.md) for how to build and contribute to this project's documentation.

docs/index.md

@@ -0,0 +1,18 @@
+# FRX Challenges
+
+Welcome to the FRX Challenges project! This is an open source repository that provides key software components for running competitive data science challenges.
+
+:::{card} Getting Started
+:link: quickstart.md
+See our quickstart guide to deploying this project.
+:::
+
+## Features
+
+- submissions!
+- evaluators!
+- teams!
+
+## Goals
+
+FRX stands for **F**rictionless **R**eproducibility e**X**change. Inspired by [Donoho, 2023](https://arxiv.org/abs/2310.00865v1).

docs/myst.yml

@@ -0,0 +1,22 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 73942dbd-1ba2-4a30-a345-526e897b7fb4
+  title: FRX Challenges
+  # description:
+  # keywords: []
+  # authors: []
+  github: https://github.com/2i2c-org/unnamed-thingity-thing
+  toc:
+    # Auto-generated by `myst init --write-toc`
+    - file: index.md
+    - file: quickstart.md
+    - title: Contribute
+      children:
+        - file: CONTRIBUTING.md
+
+site:
+  template: book-theme
+  # options:
+  #   favicon: favicon.ico
+  #   logo: site_logo.png

docs/quickstart.md

@@ -0,0 +1,7 @@
+---
+title: Get Started
+subject: Quickstart guide
+description: Get up and running deploying an FRX Challenge.
+---
+
+This is the quickstart guide to get you started with your first deployment of an FRX Challenge website.

docs/requirements.txt

@@ -0,0 +1 @@
+mystmd