nearbuilders / bos-workspace-docs

bos-workspace-docs

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

Getting started

1. Install packages

yarn install

2. 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!

bos-workspace-docs's Issues

Library: Implement bos-workspace-docs to designs

Let's try implementing the new Build DAO gateway designs for the bos-workspace docs site.

Use the app pattern already inside this app. Adjust the existing docs in this file to use these styles, remember to abstract theming and customizations appropriately. Use components from existing near builders component library

FIGMA