Skip to content

voxel51/v51-gs-draft

Repository files navigation

Guidelines for the getting started docs https://github.com/thesteve0/v51-gs-draft/blob/main/GETTING_STARTED_FORMAT.md

  1. Make a directory in docs/getting_started/focused_getting_starteds for your project
  2. Make juypter notebook in this directory
  3. Remember, all images and other files go in an "assets" directory inside project directory
  4. No GIFs. Animated images should be in webp (ideally all images are in webp).
  5. Images should not be more than 1600x wide
  6. You can do a mkdocs serve --dirty and it will render your notebook and you can preview it

YOU MUST RUN THE BUILD AND SERVE BEFORE DOING A PR - it is the only way to make sure our notebook converter can parse your file!!

  1. Continue to edit and make changes
  2. If you add links to the API or you add images as links (in the assets folder) please do a full build. This will allow you to check if all your links are correct 8. pip install -r requirements.txt 9. install node build requires it but you can also comment out in build.sh if you want 10. https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating 11. nvm install node 8. If you need the python API build.sh --skip-ts-api --venv <your venv> 9. If you don't need any APIs just images build.sh --skip-all-api --skip-clone --venv <your venv> 10. cd site/ 11. python -m http.server
  3. Don't forget to ask someone to review
  4. Reviewnb is set up for this repo but I have not tried it yet. You may need to create an account to see work with the reviews https://www.reviewnb.com/

Assumptions for the libraries we use in our notebooks:

  1. Python 3.11?
  2. Fiftyone Latest?
  3. Anything else?

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •