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

Update Qualification and Profiling tool documentation for gh-pages #3294

Conversation

sameerz
Copy link
Collaborator

@sameerz sameerz commented Aug 25, 2021

Closes #3284

Update Qualification and Profiling tool documentation to improve formatting on gh-pages.

  1. Indented a section (lines 74-76) to allow for numeric list continuation
  2. Put newline before and after ``` code blocks
  3. Removed ) after numbering so jekyll recognizes the numeric list (lines 644-657)
  4. Moved "Application Information" outside of a code block

I am unsure why "B. Analysis" is repeated on lines 689 and 699. Some clarity from @viadea would help.

Once this is merged the gh-pages docs need to be updated with this change.

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
@sameerz sameerz added the documentation Improvements or additions to documentation label Aug 25, 2021
@sameerz sameerz added this to the Aug 16 - Aug 27 milestone Aug 25, 2021
@sameerz sameerz removed the request for review from YuanLinNV August 25, 2021 04:46
Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
Copy link
Collaborator

@tgravescs tgravescs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me, thanks Sameer

@sameerz
Copy link
Collaborator Author

sameerz commented Aug 25, 2021

build

@sameerz sameerz merged commit d95afb8 into NVIDIA:branch-21.10 Aug 25, 2021
@sameerz sameerz deleted the branch-21.10-doc-qualification-tool-issue-3284 branch April 21, 2022 00:08
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

Successfully merging this pull request may close these issues.

[DOC] Tools documentation is not formatted properly
3 participants