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
114 stars 64 forks source link

Auto build docs #53

Closed brainwavecoder9 closed 1 month ago

brainwavecoder9 commented 1 month ago

SUMMARY

A number of changes to improve and automate the documentation build, and a little cleanup.

EXPLANATION

When trying to run make to build the README for #51 I ended up down a rabbit hole trying to get my build environment to be consistent (as did someone else in #24). Even after what I thought was a successful run, I still ended up with a slightly different format, which can make a very minor change seem quite complicated. Although there are a number of changes to this README, these are expected to be normalized through the new process so future changes are expected to be consistent.

This modification to the documentation creation process automates the build process in an isolated environment for creating the README file.

Additionally, a few other small changes were made to cleanup the repo and related process. A summary of all changes is below.

DESCRIPTION OF CHANGES

.github/workflows/generate-documentation.yml

.gitattributes

docs/Makefile has a number of changes:

docs/0_2_999_footer.md

docs/0_1_personal_key.md

docs/3.2_docs.md

.static/*

brainwavecoder9 commented 1 month ago

FYI @AmeliaYe

Happy to have a discussion here about any questions, or additional changes/updates that you might want related to this

brainwavecoder9 commented 1 month ago

FYI @AmeliaYe comments have been resolved.