public-docs

Developer documentation for interacting with the Kognic Platform

Kognic IO docs is built using Docusaurus 2.

Local development

cd docs-src
yarn install
yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

You can also generate static content into the build directory using the build command. This can then be served using any static contents hosting service.

cd docs-src
yarn install
yarn build

Note that the search bar does not work in development mode, so you need to run the build content if you want to test this out locally. This can be done with yarn serve.

Commiting changes to yarn.lock might break the Github Action build.

Adding a new page to the documentation

It's easy to add a new page to the documentation. Create a new markdown file in docs-srs/docs according to the page hierarchy you want. You enable users to find your page on the left side menu by making sure the file and the hierarchy is accurately reflected in sidebars.js.

Deployment

Build and deployment are done automatically by GitHub Actions on push to master.