[DOC]: Morpheus Examples link to symlinks #1356
Assignees
Labels
doc
Improvements or additions to documentation
external
This issue was filed by someone outside of the Morpheus team
Needs Triage
Need team to review and classify
Comments
jarmak-nv
added
Needs Triage
|
Hi @pranavm7! Thanks for submitting this issue - our team has been notified and we'll get back to you as soon as we can! |
|
It is a pretty simple fix! I would like to create a PR with the same :) |
pranavm7
added a commit
to pranavm7/Morpheus
that referenced
this issue
Nov 12, 2023
2 tasks
github-project-automation
bot
moved this from Review - Ready for Review
to Done
in Morpheus Boards
rapids-bot bot
pushed a commit
that referenced
this issue
Nov 22, 2023
Closes #1356 : Suggested changes made in [Examples](https://github.com/nv-morpheus/Morpheus/blob/branch-23.11/docs/source/examples.md) page! Pretty simple patch shouldn't break anything :) ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md). - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. - Pranav M Authors: - Pranav Mahajan (https://github.com/pranavm7) - David Gardner (https://github.com/dagardner-nv) Approvers: - David Gardner (https://github.com/dagardner-nv) URL: #1357
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
How would you describe the priority of this documentation request
Medium
Please provide a link or source to the relevant docs
https://github.com/nv-morpheus/Morpheus/blob/branch-23.11/docs/source/examples.md
Describe the problems in the documentation
Possible side effect of #536, the links within the Morpheus Examples document link to respective symlinks located at docs/source/examples.
However, the symlinks link to respective docs within the examples folder. This approach makes the documentation a bit difficult to read as github doesn't render symlinks, and feels a bit redundant, therefore I would like to report it as a bug.
(Optional) Propose a correction
Update links in this file from
./examples/__example_model__/README.mdto../../examples/__example_model__/README.mdCode of Conduct
The text was updated successfully, but these errors were encountered: