/wiki

wiki.seasalt.ai

Primary LanguageHTML

Intro

This repo serves wiki.seasalt.ai. Wiki is product documentation/user manual for non-technical Seasalt.ai customers.

How to Develop?

Doks

To get started with development, follow Doks. To modify and extend components of Doks, go to detailed documentation.

Develop Locally

  1. Run npm install to install all required npm packages.
  2. Run npm run start. Doks will start the Hugo development webserver accessible by default at http://localhost:1313. Saved changes will live reload in the browser.

To preview the static files that will be generated, run hugo and check /public. Open /public/index.html to see result.

Deployment

To deploy your changes, make a PR to merge changes to main branch as usual. When your code is merged to main branch, Github Actions for deployment (see .github/workflows/deploy-github.yml) will be triggered to rebuild and publish static files to gh-pages branch. The webpage, wiki.seasalt.ai, serves the static files that are pushed to gh-pages directly.