Add utility for clean builds and link checks; update README accordingly

open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package

https://open-ephys.github.io/bonsai-onix1-docs/

Creative Commons Attribution Share Alike 4.0 International

0 stars 2 forks source link

Add utility for clean builds and link checks; update README accordingly #53

Closed cjsha closed 1 month ago

cjsha commented 1 month ago

Add a powershell script to clean files and check links
Add note in README regarding the bullet point above
Fix typos in README

Misc changes not related to above issues:

index.md configured with landing page metadata in docfx.json and removed relevant metadata from the file itself
docfx.json content value refactored to be more succinct

I suggest that @bparks13 updates the workflow action to use the docfx-util.ps1 script per this comment before merging.

Fixes #24 Fixes #43

cjsha commented 1 month ago

We should add this comment as content to the README. I documented the the docfx-util.ps1 script through a bunch of asides in the Before Pushing section, but I think it would be worth giving the script its own subsection in there as well.