Skip to content

VODGroup/AccessibilityDocumentation

Repository files navigation

— What is this?

This repository is the source code of iOS Accessibility Handbook online documentation, which is an educational resource dedicated to help developers, designers, testers and researchers work on approachability of iOS applications.

The book is a collection of interactive guides and detailed articles permeated with lots of exemplary illustrations that cover everything one could ever need to know about implementing accessibility.

prs prs

The material is split into chapters by its relation to a certain topic. The chapters are joined into volumes by the depth of the knowledge inside. This way everyone can find something useful for themselves regardless of their level of expertise.

— Who is responsible of this?

Majorly the project is based on the content of About Accessibility on iOS book written by Mikhail Rubanov. prs prs The book is essentially a complete course on accessibility of iOS applications, but being a traditional book — moreover available in Russian language exclusively — sucks. So here we are, happily putting videos and code samples on the documentation pages! Have fun.

— Why make it a website?

Websites is an exemplary cross-platform solution. Having resources available on the Net widens its availability — one has to have nothing more than a web browser and an Internet connection to access the resource.

— How does it function?

The interactivity is implemented by heavy relying on DocC technology, which is a native rich documentation solution for Swift projects. It uses Markdown as its formatting language. prs prs

The resource is hosted by GitHub Pages, which is a great option to allow anyone to contribute to the project. GitHub Pages simply turns a GitHub repository into a website, which plays along open-source development fittingly.

— Can I contribute to the project?

Yes, everyone is welcome to influence the project, especially considering its non-commercial nature. It can be done by committing ideas and fixes to this repository or straightforwardly reaching someone from the team. A few examples of doing this:

  • describe a problem or discuss on the topic in Issues; issues issues

  • propose a change by creating a pull request to this repository; prs prs

  • get in contact with one of the responsible editors by using the credential information they've provided. contributors contributors

Sponsored by VoiceOver Designer

VoiceOver Designer is a macOS application that allows to design and prototype accessibility features over a screenshot of an app.

More about the app: https://rubanov.dev/voice-over-designer

Code source: https://github.com/VODGroup/VoiceOverDesigner

vod-sample vod-sample

Releases

No releases published

Packages

No packages published

Languages