sablier-labs / v1-docs

Documentation website for Sablier V1

Sablier Docs

Contributing to the Sablier docs is a great way to get involved in the dev community and help other people along the way.

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

Installation

$ pnpm install

Local Development

$ pnpm 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

$ pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

v1-docs's Issues

Settle on either "package-lock.json" or "yarn.lock"

It's not good practice to track both lock files in version control. npm and yarn behave differently, so they may end up overriding each other's node_modules directories.

Change the icon color for link previews when in dark mode

Upgrade to stable Docusaurus packages

See notice that appears when running yarn start:

Document Sablier V1.0 addresses

Sablier V1.0 is still being tracked by various tools (e.g. Dune Analytics), so it would be helpful to document the Sablier V1.0 addresses in our documentation website.