Skip to content

Add documentation #6

Description

@JaceHensley

We need better documentation for all the libraries in this repo.

Acceptance Criteria:

  • Top level docs/ folder
    • Single docusaurus instance that has a folder for each library
  • Publish to GitHub pages, using a GitHub action like:
name: build docs
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          persist-credentials: false
      - name: Build Docs
        run: |
          cd docs
          npm i
          npm run docs:build
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/build
          allow_empty_commit: true
          force_orphan: true

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions