Tensile icon indicating copy to clipboard operation
Tensile copied to clipboard

Creating Tensile Documentation

Open SwRaw opened this issue 1 year ago • 5 comments

SwRaw avatar Aug 01 '24 07:08 SwRaw

@SwRaw changes are looking good. Once you apply the comments, please resolve the items and I'll do a final review.

bstefanuk avatar Aug 16 '24 22:08 bstefanuk

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github? I found these: https://alt-doc-doc-test.readthedocs.io/en/latest/ROCm_Tools/tensile.html https://new-documentation.readthedocs.io/en/latest/ROCm_Tools/tensile.html#contributing which are also different?

pghysels avatar Aug 28 '24 15:08 pghysels

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github?

@pghysels We're in the process of moving Tensile's Wiki into ROCm docs. As a part of this effort, we're working on restructuring some of the documents to match other library standards. The links you provided appear to be generated from the Wiki content, but I'm not familiar with who has published these, I suspect they're unofficial.

Until this migration is complete, the official AMD docs are hosted privately.

bstefanuk avatar Aug 28 '24 17:08 bstefanuk

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github? I found these: https://alt-doc-doc-test.readthedocs.io/en/latest/ROCm_Tools/tensile.html https://new-documentation.readthedocs.io/en/latest/ROCm_Tools/tensile.html#contributing which are also different?

You can see the docs here: https://advanced-micro-devices-demo--1999.com.readthedocs.build/projects/Tensile/en/1999/src/index.html

SwRaw avatar Aug 29 '24 06:08 SwRaw

@SwRaw A few things I noticed regarding the following picture of the side bar: image

Can we move the CLI reference dropdown outside of the API reference please. Also, let's make API reference a drop-down too and nest them both under the Reference section.

bstefanuk avatar Aug 29 '24 19:08 bstefanuk

@bstefanuk I am struggling to create the nested TOC structure as requested by you. Let me know if you have any idea on how to nest captions.

SwRaw avatar Sep 01 '24 16:09 SwRaw