Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #6

Open
JaceHensley opened this issue May 11, 2021 · 0 comments
Open

Add documentation #6

JaceHensley opened this issue May 11, 2021 · 0 comments

Comments

@JaceHensley
Copy link
Contributor

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant