Closed mcfadden8 closed 8 months ago
I'll need to pull that generated html into our github pages DM documentation. For now, you can use this link to see the rendered HTML: https://htmlpreview.github.io/?https://github.com/NearNodeFlash/nnf-dm/blob/master/daemons/compute/copy-offload-api.html or pull the source and view it locally using a browser.
@mcfadden8, this has been fixed and the API docs have been added to the development version of our documentation: https://nearnodeflash.github.io/dev/guides/data-movement/copy-offload-api.html
Links have been added for the Copy Offload API and the link in the last paragraph of the Data Movement Documenation has been fixed to point to it.
Unfortunately, this problem is still happening to me. I used a private browser to avoid any cached pages.
You will need to make sure you are viewing the dev
version of the documenation: https://nearnodeflash.github.io/dev/
You can get to this from the dropdown on the top of the page:
You can then navigate to the Copy Offload API docs directly (or use the link in that last paragraph):
The next release will include this change and you will not need to use the dev
version.
When I select the CreateRequest API link from the last paragraph of the fully rendered Data Movement documentation, I am taken to the readme markdown document for the nnf-dm deamons. The API Definition section within this readme file offers a link to the Copy Offload API Documentation which takes me to the html source code for the offload API.
My expected behavior is to have a link to the rendered documentation so that I may read it.