Skip to content

Abbreviated class names are not included in the documentation #102

Description

@trichoplax

Describe the bug
The documentation only mentions the full class names. This means that reading the documentation gives no indication of the meaning of the abbreviated class names. Currently the abbreviations can only be found by searching the code.

For example:
The documentation mentions the class has-padding-vertical-2 in Box styles, but does not mention that this can be abbreviated to h-p-v-2.

Could the abbreviated class names be included somewhere in the documentation? Since the meanings are not obvious, perhaps it would be helpful to include them in 2 places:

  1. In context in the current documentation, alongside their corresponding unabbreviated class names.
  2. In a separate "glossary" that lists all the abbreviated class names in alphabetical order, each showing its corresponding unabbreviated class name.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions