Skip to content

further suggestions for docs stuff #14

Description

@annibond

These aren't necessary to understand your docs, but I thought you might want to hear them:

  • Your worfklows are great, but for the purposes of accessibility, I really recommend using alt text for those. There's a tag for that: this is where the alt text goes. It's an a11y standards thing but it's also how screen readers process it, which isn't limited to low-to-no vision users.
  • Have a place where you stick what commands you do for your app (e.g., import, def some_func(), etc.) like old help prompts would say.
  • A glossary for terms that your user base won't necessarily understand

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions