Edited landing page and installation pages. #3716
Conversation
Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
| aside.toc-drawer ul ul ul ul { | ||
| display: none; | ||
| /* | ||
| * Highlight color for code segments |
There was a problem hiding this comment.
Code snippets within .. parsed-literal:: are still not changed to new background color? Have you verified this?
|
|
||
| aside.toc-drawer ul ul ul ul { |
There was a problem hiding this comment.
Could you remind me why we initially included this, and why it's no longer necessary?
There was a problem hiding this comment.
This was a workaround to keep the lower-level entries from showing up in the page TOC (the one in the right-hand sidebar). I think I found a less hack-y way to do this, but I don't recall exactly what offhand.
| .toctree-l3 { | ||
| display: none; | ||
| } | ||
| /* | ||
| * Table options | ||
| */ | ||
|
|
||
| [for^="toctree-checkbox-"], [id^="toctree-checkbox-"] { | ||
| visibility: hidden; |
There was a problem hiding this comment.
Could you remind me why we initially included this, and why it's no longer necessary?
| .. code-block:: bash | ||
|
|
||
| python3 -m pip install aimet-torch | ||
| Prerequisites |
There was a problem hiding this comment.
We decided to remove the prerequisites section from the quick start guide for pip install aimet-torch because these are no longer required for installing aimet-torch. The package is now compatible with all platforms by default. We only wanted to indicate that we have verified it using one specific host configuration, which is why we included that information after the pip install aimet-torch command.
So, could you please revert this change?
cc; @quic-kyunggeu
There was a problem hiding this comment.
Rather than a Prerequisites section then, how about a note laying out the test platform, but say it should work on all or most platforms?
| @@ -26,19 +20,29 @@ AIMET PyTorch package has been tested using the following recommended host platf | |||
| * Nvidia GPU card (Compute capability 5.2 or later) | |||
| * Nvidia driver version 455 or later (using the latest driver is recommended; both CUDA and cuDNN are supported) | |||
|
|
|||
| Verification | |||
| ============ | |||
| Installating AIMET | |||
There was a problem hiding this comment.
Typo here: Installating
| @@ -1,283 +0,0 @@ | |||
| .rst-content .hideitem { | |||
There was a problem hiding this comment.
Could you tell why the legacy stylesheet and conf.py file were removed? Is this impacting the rendering of the new documentation in any way?
If not, can you please revert these two files? We will eventually delete entire legacy directory.
We might need these two files if we want to build the old docs for the past releases (highly unlikely though) - we can get these two files from the git history but as I said we would to delete entire directory at some point in future.
| .. note:: | ||
| See the :doc:`glossary <../glossary>` for explanations of terms and acronyms used on this website. |
There was a problem hiding this comment.
Would this be the ideal spot on the landing page to feature the glossary, considering it's the first thing users are likely to look at...?
How about putting after the release notes page..
|
Closing. Re-creating without the formatting and file deletions. |
|
Closing. |
Edited all installation pages including quick start.
Edited landing page.
Removed legacy conf.py and CSS files as unnecessary.
Fixed parsed literal box background color.