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

Fix markdown issue in documentation issue reporting note #1451

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

bismurphy
Copy link
Contributor

@bismurphy bismurphy commented Aug 5, 2024

Somewhat amusingly, the documentation's note regarding reporting an issue was broken, thus making it impossible to report the issue itself. For convenience, here is the live page which has the bad link: https://docs.openc3.com/docs/getting-started/installation

The link syntax was broken and was generating a bad URL with a "> included, which leads to a GitHub 404 page. I've removed the extra parts, and I believe the link now works as-expected, giving the option of which type of New Issue to create (although it may be nice if the issue types included "Documentation changes" or similar).

Additionally, this was the only :::note block which was tabbed-in across all the docs, so I made the choice to un-tab that. Not sure if that was meant to be tabbed in but my guess is that it should match all the others - my Markdown viewer was misbehaving since the tab in was causing it to render as code rather than parsing the Markdown link syntax.

Thanks for a nice SmallSat talk :)

@ryanmelt
Copy link
Member

ryanmelt commented Aug 5, 2024

Thanks! We'll get that fix deployed with our next release.

@ryanmelt ryanmelt merged commit 6540996 into OpenC3:main Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants