Updating docs doesn't describe all the tools required to update the docs

NVIDIA / nim-anywhere

Accelerate your Gen AI with NVIDIA NIM and NVIDIA AI Workbench

https://www.nvidia.com/en-us/ai/

Apache License 2.0

97 stars 57 forks source link

Updating docs doesn't describe all the tools required to update the docs #24

Open freemansoft opened 2 months ago

freemansoft commented 2 months ago

Updating docs requires additional utility software and a Make environment. Those aren't called out in https://github.com/nvidia/nim-anywhere?tab=readme-ov-file#updating-documentation

Also, the makefile assumes you are running a linux shell which is fine but maybe should be mentioned. Note that this didn't run on my Mac either.

brainwavecoder9 commented 1 week ago

I ran into similar concerns. I ended up chasing this down and submitting #53. The PR fully automates the process and handles the generation on-commit within a Git runner.

brainwavecoder9 commented 19 hours ago

The docs build process has moved to a Git Runner so there's no longer a need to manage anything locally.

FYI for freemansoft and also this can probably be closed.