Skip to content

Commit

Permalink
Use local documentation, publish automatically, and a start on docume…
Browse files Browse the repository at this point in the history
…nting `mi syn` (#12)

* Use local files, not pulled from repos

* GitHub Action to deploy to Pages

* Restructure according to the four categories documentation model

* mi syn documentation
  • Loading branch information
elegios committed Sep 28, 2023
1 parent f1bf85f commit 0fd21c4
Show file tree
Hide file tree
Showing 23 changed files with 2,847 additions and 19 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Deploy to GitHub Pages automatically

on:
push:
branches: [master]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "16"
cache: npm
cache-dependency-path: package-lock.json
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: "npm install"
- name: Build with Docusaurus
run: "npm run build"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'build'

# Deploy job
deploy:
# Add a dependency to the build job
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 0 additions & 2 deletions docs/.gitignore

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_miking-dppl-remote.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_miking-remote.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/explanations/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
position: 5
label: 'Explanations'
1 change: 1 addition & 0 deletions docs/explanations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Explanations
10 changes: 10 additions & 0 deletions docs/explanations/installing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
---

# Installing Miking

:::note

TODO

:::
2 changes: 2 additions & 0 deletions docs/how-to-guides/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
position: 3
label: 'How-to Guides'
1 change: 1 addition & 0 deletions docs/how-to-guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How-to Guides
10 changes: 10 additions & 0 deletions docs/how-to-guides/installing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
---

# Installing Miking

:::note

TODO

:::
23 changes: 23 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 1
id: root
---
# Miking Documentation

Miking is a meta-language system for creating embedded languages, and this site holds its documentation.

We are currently in the process of restructuring our documentation (see [here](https://documentation.divio.com/) for more information on the intent), thus some information can be found in the first four categories below (where they should be) and some can be found in the fifth category.

## Content

- [Tutorials](./tutorials/index.md) are meant for initial learning, and give step-by-step instructions for solving small, self-contained tasks.
- [How-to guides](./how-to-guides/index.md) give step-by-step instructions on how to accomplish commonly occurring tasks or solve problems.
- The [Reference](./reference/index.md) documents the more technical details of the project: APIs, syntax, semantics, etc.
- [Explanations](./explanations/index.md) give more theoretical descriptions of concepts used in the Miking project, how they relate, and why they are designed the way they are.

## Old Content

The old documentation can be found here while the documentation restructuring is in progress:

- The [Miking](/miking-readme) README.
- The [Miking DPPL](/miking-dppl-readme) README.
2 changes: 2 additions & 0 deletions docs/reference/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
position: 4
label: 'Reference'
1 change: 1 addition & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Reference
Loading

0 comments on commit 0fd21c4

Please sign in to comment.