Skip to content

[DOC] - Consistency on usage of angle brackets for variables and urls #510

Open
@kcpevey

Description

@kcpevey

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    • Status

      Todo 📬

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions