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

Do not use the <tt> tag in documentation #888

Open
christophertubbs opened this issue Oct 7, 2024 · 0 comments
Open

Do not use the <tt> tag in documentation #888

christophertubbs opened this issue Oct 7, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@christophertubbs
Copy link
Contributor

The <tt> tag shows up in some of the documentation, but it is not a supported tag in HTML5, as a result, we have some documentation rendered that does not render the <tt> tag correctly and literally reads <tt>production</tt> instead of production.

This might be fixed with a simple find and replace with <tt>-><code> and </tt>-></code> or just use something like the <samp> tag if you're feeling fancy.

An example of the issue may be found at: https://noaa-owp.github.io/ngen/md_doc_2_g_i_t___u_s_a_g_e.html#autotoc_md173

@christophertubbs christophertubbs added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant