Accessibility

The ukpyn documentation aims to be usable for beginners and accessible to people with a wide range of access needs.

Accessibility principles used on this site

• Keep structure consistent across pages so navigation is predictable
• Use clear headings and short sections to support scanning
• Prefer plain language and define domain terms
• Keep colour use theme-compatible
• Avoid relying on colour alone to convey meaning
• Support keyboard-first use for core navigation and interaction

Plain-language writing commitments

We aim to:

• Define specialist words in the Glossary
• Explain new concepts before using them in examples
• Keep sentences short where possible
• Use descriptive link text instead of "click here"

Accessible code guidance

• Keep examples small and runnable
• Show complete command lines that can be copied directly
• Add context before code so readers know expected inputs and outputs
• Avoid unnecessary abbreviations in variable names
• Prefer stable formatting for code blocks and inline code

Keyboard navigation tips

• Use Tab and Shift+Tab to move between links, controls, and search
• Use Enter to activate a focused link or button
• Use browser find (Ctrl+F / Cmd+F) to locate key terms quickly
• Use the page table of contents to jump between sections
• Keyboard behaviour may vary slightly by browser, operating system, and assistive technology.

Report an accessibility issue

• The page URL
• What assistive technology or browser you use (if relevant)
• What happened and what you expected
• Suggested improvement (if you have one)

Project repository: https://github.com/UKPN-DSO/ukpyn/issues