Skip to content

Commit

Permalink
final landing page i guess
Browse files Browse the repository at this point in the history
  • Loading branch information
crescentheaded committed Jun 3, 2024
1 parent d673770 commit ee16f23
Show file tree
Hide file tree
Showing 80 changed files with 33 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,53 +25,63 @@ Make your iOS applications **accessible**

## Welcome to iOS Accessibility Handbook

[**iOS Accessibility Handbook**](<doc:iOSAccessibilityHandbook>) is an open-source **educational project** about making iOS applications *accessible*.
[**iOS Accessibility Handbook**](<doc:iOSAccessibilityHandbook>) is an open-source **educational project** about making iOS applications **accessible**.

**Accessible application** is such application that works with various *assistive technologies*, such as [**VoiceOver**](<doc:VoiceOver>), [**Voice Control**](<doc:VoiceControl>) and [**Switch Control**](<doc:SwitchControl>), which enable **people with disabilities** to use the application.
**Accessible applications** work with various [**assistive technologies**](<doc:AccessibilityFeatures>), such as [**VoiceOver**](<doc:VoiceOver>), [**Voice Control**](<doc:VoiceControl>) and [**Switch Control**](<doc:SwitchControl>), which enable **people with disabilities** to use the application.
@Image(source: features-1, alt: "")
@Image(source: features-2, alt: "")

### Interactive learning
This handbook provides *extended documentation* of [**Accessibility Features**](<doc:AccessibilityFeatures>) API, including:
- verbose *articles* on the topic;
- interactive *guides* to follow step-by-step;
- various media, such as *video tutorials*.
The handbook provides **extended documentation** of **[Accessibility Features](<doc:AccessibilityFeatures>) API**, including:
- detailed **articles** on essential topics;
- interactive **guides** to follow step-by-step;
- various media, such as **video tutorials**.

In other words, materials here cover **everything one could ever need to know about accessibility on iOS**.
In other words, materials here cover **everything one could ever need to know about accessibility** of iOS development.

@Links(visualStyle: detailedGrid) {
- <doc:iOSAccessibility>
- <doc:AccessibilityFeatures>
}

### Target audience
The project is dedicated to help *developers*, *designers*, *testers*, *researchers* and *mere users* — in other words, **everyone working with accessibility** on iOS.

There is **no commercial underlayment** and the only reason the project exists is to **popularise the topic** and **share** relevant real-life experience of contributing **accessibility professionals**.
The project is dedicated to help *developers*, *designers*, *testers*, *researchers* and *mere users* — in other words, **everyone dealing with accessibility** on iOS.

There is **no commercial underlayment**. The only reason the project exists is to **popularise the topic** and **share the experience** of contributors.

## Contributors
@Row(numberOfColumns: 2) {
@Column {
### Mikhail Rubanov
The resources are provided by [**Mikhail Rubanov**](https://rubanov.dev), **Head of Mobile Development** at [**Dodo Brands**](https://dodobrands.io), an accessibility professional and the author of ["**About iOS Accessibility**"]( https://rubanov.dev/a11y-book) book.

Exemplary and illustrative materials are **based on his working experience**.
}
@Column {
@Image(source: "about-ios-accessibility", alt: "-")
}
}

## Site structure
## About the website

The handbook is essentially a *complete course* of **how to make iOS applications accessible**. The materials are split into conceptual *topics* and categorised by its relation to a particular [**assistive technology**](<doc:AccessibilityFeatures>) and its field of implementation.
**iOS Accessibility Handbook** is essentially a **complete course** of modern [**digital accessibility**](<doc:a11yTerminology>) practices from the perspective of iOS development.

@Image(source: book-content, alt: "")

To know more about the book's structure take a look at the left side of the page where the [**Table of Contents**](https://vodgroup.github.io/AccessibilityDocumentation/documentation/iosaccessibilityhandbook/#topics) is located.
To know more about the *curriculum* visit the [**Table of Contents**](<doc:AdoptionGuide>) page.

### Technical implementation
At the moment the project's form is defined by being a *documentation catalog* ([**DocC**](https://www.swift.org/documentation/docc)) hosted by [**GitHub pages**](https://pages.github.com).

To **contribute** to the project visit its [GitHub page](https://github.com/VODGroup/AccessibilityDocumentation) and see the instruction of how you may help.
At the moment the project is a **documentation catalog ([DocC](https://www.swift.org/documentation/docc))** hosted by [**GitHub pages**](https://pages.github.com).

### Contributors
The resources are provided by **Mikhail Rubanov**, Head of Mobile Development at [**Dodo Brands**](https://dodobrands.io), an accessibility activist and the author of ["**About Accessibility on iOS**"]( https://rubanov.dev/a11y-book) book. Exemplary and illustrative materials are based on his *working experience*.
@Image(source: "book-sample", alt: "-")
To **contribute** to the project visit its **repository on [GitHub](https://github.com/VODGroup/AccessibilityDocumentation)** and see the How to Help the Project **instruction**.

### VoiceOver Designer
Reading the book you may notice screenshots of iOS applications with *mark-ups* related to **accessibility design** over them. This is [**VoiceOver Designer**](https://rubanov.dev/voice-over-designer), an [open-source](https://github.com/VODGroup/VoiceOverDesigner) macOS application that allows to design *accessible interfaces* over a screenshot of an app.
## VoiceOver Designer
Reading the book you may notice **screenshots of iOS applications with mark-ups** related to [**accessibility description**](<doc:AccessibilityAttributes>) over them.
@Image(source: "vod-sample", alt: "-")
This is [**VoiceOver Designer**](https://rubanov.dev/voice-over-designer), an [open-source](https://github.com/VODGroup/VoiceOverDesigner) macOS application that allows to **design accessible interfaces over a screenshot of an app**.

### Design resources
Illustrative materials created exclusively for the book can be found [**here**]( https://www.figma.com/file/mBvxYSGy76H3666hve6v46/iOS-Accessibility-Handbook?type=design&node-id=0%3A1&mode=design&t=FsJalTP4YZeRBUoe-1).
## Handbook design resources
Graphic illustrations created exclusively for the course can be found [**here**]( https://www.figma.com/file/mBvxYSGy76H3666hve6v46/iOS-Accessibility-Handbook?type=design&node-id=0%3A1&mode=design&t=FsJalTP4YZeRBUoe-1).

@Small {
*iOS Accessibility Handbook, 2024*
Expand Down
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.

0 comments on commit ee16f23

Please sign in to comment.