Website

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

Notes

1. not using blog - we have deleted the blog directory & disabled the blog plugin
2. we are using typescript, which has some uniqueness within docusaurus
3. Embedding dynamic content? We use MDX-Embed
   • docs/intro.mdx shows an example with youtube
   • Don't use mdx. It breaks the CMS.

How to Edit these docs

• Full Editing functionality is possible by following Installation, Local Development and Build steps below.
• CMS based editing is possible via Netlify CMS, though there are some functionality gaps / tradeoffs. See Partial Editing with Netlify CMS below.

Full Editing

Installation

yarn

Local Development

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.

Build

Builds are automatic via CI/CD pipeline using fleek.

Deployment

PRs are automatically deployed on fleek.

Updating Contract Documentation

The contract documentation is generated from the olympus-v3 repository. To update the pinned commit and regenerate the documentation:

Updating the olympus-v3 Pin

1. Update the revision in foundry.toml: Open foundry.toml and update the rev field for the olympus-v3 dependency to the desired commit hash.

2. Update the revision in soldeer.lock: Open soldeer.lock and update the version field for the olympus-v3 dependency to match the same commit hash.

3. Regenerate the contract documentation:

   yarn run build:contracts

4. Commit the changes:

   git add foundry.toml soldeer.lock
   git commit -m "Update contract documentation to latest olympus-v3 commit"

What the Build Script Does

The yarn run build:contracts command (which runs contracts.sh):

• Builds the olympus-v3 project
• Generates forge documentation
• Cleans up unnecessary directories (scripts, tests)
• Fixes markdown issues and broken links
• Updates the contract documentation in docs/contracts/02_docs/

Partial Editing with Netlify CMS

• Netlify CMS is available at https://admin-docs.olympusdao.finance/.
• Netlify CMS is served from the netlify-cms branch. All changes to Netlify CMS config happen in static/admin. If you make a change here you need to push that change first to main and then merge that change down to netlify-cms branch.
• it requires login with github credentials
• all changes will read/write against the main branch
• all submitted changes will be submitted as pull requests
• Netlify CMS ONLY READS and WRITES DATA to/from github... it does not read/write any local changes you might have on your local machine
• Netlify CMS does not parse mdx files, so none of the mdx files appear
• Netlify CMS parses each docs directory separately, so a new directory would require updates to config.yml