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

[DOC]: Proof read docs/source/index.rst #541

Closed
2 tasks done
dagardner-nv opened this issue Dec 13, 2022 · 2 comments · Fixed by #572
Closed
2 tasks done

[DOC]: Proof read docs/source/index.rst #541

dagardner-nv opened this issue Dec 13, 2022 · 2 comments · Fixed by #572
Assignees
Labels
doc Improvements or additions to documentation

Comments

@dagardner-nv
Copy link
Contributor

How would you describe the priority of this documentation request

Medium

Please provide a link or source to the relevant docs

docs/source/index.rst

Describe the problems in the documentation

Please proof read the docs/source/index.rst in the https://github.com/dagardner-nv/Morpheus/tree/david-docs-23.01-restructure branch and run spell check on the rendered text.

(Optional) Propose a correction

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report
@dagardner-nv dagardner-nv added the doc Improvements or additions to documentation label Dec 13, 2022
@efajardo-nv
Copy link
Contributor

LGTM. I was able to build docs. Everything rendered fine. Proofread and spell checked. All links worked. Only thing I noticed was search link on bottom took you to a page that didn't offer any way to search. Assume that's still WIP.

@dagardner-nv
Copy link
Contributor Author

dagardner-nv commented Dec 16, 2022

That's a good catch, I noticed that the search box on the left does work, and directs to search.html, however the search link at the bottom goes to the same page but as you pointed out it doesn't display a search box.

I suppose since the search box on the left does work, this might be intentional, but since it doesn't do much, I'm thinking we should just remove that line:

* :ref:`search`

@ghost ghost closed this as completed in #572 Dec 19, 2022
ghost pushed a commit that referenced this issue Dec 19, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants