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] - Consistency on usage of angle brackets for variables and urls #510

Open
1 task done
kcpevey opened this issue Aug 21, 2024 · 1 comment
Open
1 task done

Comments

@kcpevey
Copy link
Contributor

kcpevey commented Aug 21, 2024

Preliminary Checks

Summary

The docs currently have an inconsistent usage of angle brackets and curly brackets. We should pick one and go with it. After the initial suggestion from @Adam-D-Lewis, I'm in agreement with using angle brackets, < and > across all docs.

IMPORTANT: After #503 is merged, usage of the angle brackets will require escaping them with a slash, otherwise docusaurus will throw errors.

Steps to Resolve this Issue

  1. Review all the docs for curly brackets
  2. Switch to angle brackets
@krassowski
Copy link
Member

Also reported in #403

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo 📬
Development

No branches or pull requests

2 participants