Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 850 Bytes

README.md

File metadata and controls

30 lines (19 loc) · 850 Bytes
Raw

bos-workspace-docs

This repository holds the bos-workspace docs and a customizable documentation site.

Getting started

  1. Install packages
yarn install
  1. Start dev environment
yarn run dev

This will start a gateway at 127.0.0.1:8080 which will render your local widgets. The entry point for this app is docs.bos-workspace.testnet/widget/index

Adding documents

Currently, the process is:

  1. Write your document in the /md directory
  2. Add the reference in utils/db, this will get picked up by the sidebar
  3. Confirm section/subsection matches path after /md
  4. Push to branch (configure branch in github adapter) to see updates.

Let's build better!