Closed jaydeluca closed 3 months ago
@jaydeluca thanks for raising the ticket, we just recently migrated documentation to GitHub Pages and something might look wrong
we will work on the necessary fixes
:tada: This issue has been resolved in version 5.2.6 :tada:
The release is available on GitHub release
Your semantic-release bot :package::rocket:
While reading the documentation, I have been encountering what looks like what might be broken links or references, where there is a
{ref}
followed by what looks like should be a hyperlink of some sortExample:
Examples in code base:
When rendered on the doc site they look like:
Should these be linking to something or formatting differently?
Also, anywhere there is an example cli argument, there is usually a placeholder explaining what the value should be, but they are all missing a closing
>
.Example: https://github.com/splunk/pytest-splunk-addon/blob/b789bb480e590c8182b94f35548ec4bcf7b3c263/docs/how_to_use.md?plain=1#L23
Should these instead be closed like below or is this intentional?