Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Improve Right Sidebar Table of Contents Structure for Neuron Compiler CLI Reference Guide #1105

Open
tonyz0x0 opened this issue Feb 4, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tonyz0x0
Copy link

tonyz0x0 commented Feb 4, 2025

Issue Description

The right sidebar table of contents (TOC) for the Neuron Compiler CLI Reference Guide currently lacks proper structure and depth, making it difficult to navigate through available commands and options.

Current Behavior

  • The right sidebar TOC only shows two top-level entries:
    • "Usage"
    • "Available Commands"
  • Important CLI commands like compile and list-operators are not visible in the TOC
  • Users cannot quickly jump to specific command documentation without scrolling through the page

Expected Behavior

The right sidebar TOC should show a hierarchical structure that includes:

  • Usage
  • Available Commands
    • compile
      • Parameters and options
    • list-operators
    • [other commands]
  • Common Parameters
    • --help
    • [other parameters]

Image

@aws-satyajith aws-satyajith added the documentation Improvements or additions to documentation label Feb 4, 2025
@aws-satyajith
Copy link

Thank you for your documentation format change suggestion. We’ll add your suggestion to our list for future changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants