fp-ts-std icon indicating copy to clipboard operation
fp-ts-std copied to clipboard

Don't commit docs

Open samhh opened this issue 3 years ago • 2 comments

Ideally they're generated. This'll mean cleaning up and exposing tshm-docs-ts.

samhh avatar Oct 07 '22 11:10 samhh

tshm-docs-ts is in the Nix shell as of https://github.com/samhh/fp-ts-std/commit/34754889a78ff402ad328e85909cc5df73ed864c.

samhh avatar Apr 21 '23 18:04 samhh

GitHub now supports deploying docs via Actions. Rough example of how this could look:

on:
  push:
    branches:
      - master

jobs:
  docs:
    name: Publish docs
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write
      pages: write
    steps:
      - uses: actions/checkout@v3
      - uses: cachix/install-nix-action@v21
      - run: nix develop -c yarn run docs
      - uses: actions/upload-pages-artifact@v1
        with:
          path: ./docs/
      - uses: actions/deploy-pages@v2

The tshm-docs-ts Nix derivation will probably need a little bit of fiddling first. Edit: This should be fine now.

It's still useful to generate the docs during dev, so :/docs/ would need adding to .gitignore.

samhh avatar Jun 03 '23 20:06 samhh