NearNodeFlash / NearNodeFlash.github.io

View this document https://nearnodeflash.github.io/
Apache License 2.0
3 stars 3 forks source link

Added nnf-dm submodule to pull in auto-generated Copy Offload API #112

Closed bdevcich closed 8 months ago

bdevcich commented 8 months ago

The Copy Offload API documentation is auto-generated using a gRPC plugin that produces HTML output. This document resides in the nnf-dm repository.

This adds a submodule for nnf-dm and a symbolic link to the auto-generated html. This allows the HTML to be displayed directly in the documentation on GitHub pages. Links to the HTML have been added.

The symbolic link should provide seamless support for versioning.

bdevcich commented 8 months ago

Note that the HTML displays itself only - the sidebar and header that the docs normally have aren't displayed. The HTML isn't embedded and styled like the other markdown pages.

Example: Screenshot 2023-10-31 at 2 20 00 PM