W&B Docs

This repository contains the documentation for W&B, it uses the excellent Docusaurus for site generation.

Conventions

• wandb - refers to the CLI or library
• W&B - refers to the website or service
• Weights & Biases - refers to the company

Install

yarn add docusaurus

Development

cd website
yarn start

You should be able to refresh your browser to see basic changes. If you change the config or yaml front matter, you will need to manually restart for now.

Contributing

To contribution to the documentation edit the corresponding file in the 'docs' folder and submit your changes in a pull request. The Weights & Biases team will merge your change and deploy the new documentation. Thank you for contributing!

Deployment

# Be sure to commit and push your changes before every deploy so everyone stays synchronized
git commit -a -m "DESCRIPTION OF CHANGES"
git push

yarn deploy
# Behind the scenes this runs:
# GIT_USER=$USER USE_SSH=true yarn run publish-gh-pages
# If $USER is not your github username you'll have to run it manually
#