Skip to content

add docusaurus documentation - #110

Draft
Frontrider wants to merge 3 commits into
danielmartin0:mainfrom
Frontrider:main
Draft

add docusaurus documentation#110
Frontrider wants to merge 3 commits into
danielmartin0:mainfrom
Frontrider:main

Conversation

@Frontrider

@Frontrider Frontrider commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Description

Documentation moved from the readme into docusaurus as multiple markdown files.
Includes a workflow to deploy the docs as a github page.

The workflow won't work until github pages is enabled.

Checklist

  • Changes have been tested
  • Changes do not break backwards compatibility
  • changelog.txt has been updated
  • README.md has been updated (documentation section and/or Contributors list)

Testing Notes

Run these commands inside the site folder:
npm run docusaurus build
npm run docusaurus serve

Build is needed for the search to work. NPM needs to be installed to run it locally.

@nicholasgower
nicholasgower marked this pull request as draft August 5, 2026 22:46
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

Successfully merging this pull request may close these issues.

1 participant