ergogen/ergogen-docs

Ergogen docs using docusaurus

Ergogen documentation

This repository contains the documentation for Ergogen.
The latest version is deployed here.

Contributing

To submit improvements and fixes to the documentation: fork this repository and make your changes in /docs. You can preview your changes using a local setup or by submitting a PR to get a deployment preview built for you.

Deployment

PRs that are merged into the main branch will automatically be deployed to https://docs.ergogen.xyz/ using GitHub actions.

Local Development

$ yarn
$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Note that Node.js v17 changed to OpenSSL 3.0, causing a startup error in the current config, which (for the time being) can be circumvented by using NODE_OPTIONS="--openssl-legacy-provider" yarn start instead.

This website is built using Docusaurus 2, a modern static website generator.

ergogen-docs's Issues

Explain refs more clearly

I read the docs and I don't understand what is used to determine a ref. I'm trying to play around with it on https://ergogen.cache.works/ default example.

I tried to change the points.mirror.ref to a variety of things like thumbfan_near_home and thumbfan_far_origin. Nothing in the thumbfan context seems to work. I'd like to judge the distance between mirrors based on the distance from the thumb key furthest to the left. Can this be done?

Link to join Discord channel is broken

Pretty straightforward, https://discord.gg/nbKcAZB doesn't work.

Invite Invalid
This invite may be expired, or you might not have permission to join.

Can be fixed by doing a global replace of https://discord.gg/nbKcAZB with a valid invite link.

Cheers!