microsoft
/
accessibility-insights-windows
зеркало из https://github.com/microsoft/accessibility-insights-windows.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
accessibility-insights-windows/docs/FAQ.md

66 строки
3.6 KiB
Markdown
Исходник Обычный вид История

Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
## FAQ
#### Q. What is Accessibility Insights for Windows?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Accessibility Insights for Windows is the project for Accessibility tools on Windows platform (Win7/Win8x/Win10). This is one of the tools from a suite of tools that help diagnose accessibility issues.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. Why should I contribute to Accessibility Insights for Windows?
Reword "differently abled people" to "people with disabilities" ("people first" guidelines) (#392)
2019-06-20 02:19:45 +03:00
By contributing you will help ensure that people with disabilities have full access to applications. Make the world a better place!
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How do I get started?
Improvements to FAQ and readme
2019-01-31 03:09:25 +03:00
Visit the [Readme](../README.md) and the [Overview](Overview.md) page.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Once you are ready to make a contribution visit the [Contributions](../Contributing.md) page.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. Where can I download the application?
You can download and install the application from https://accessibilityinsights.io.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How can I add or change an automated accessibility test?
Replace URL with linked text in FAQ (#405) This is more aesthetically appealing. - Fix spelling error for "extenstions" - Fix spelling error for "vist"
2019-06-28 01:13:39 +03:00
Accessibility Insights uses rules from [axe-windows](https://github.com/microsoft/axe-windows). Please refer to the docs folder there about contributing additional rules.
Adding rules overview documentation
2019-02-15 20:57:44 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How do I go about adding unit tests?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Please follow the guidelines outline in the [Adding Unit Tests](AddUnitTests.md) page.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. Where can I find the standards for unit tests?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Standards have been documented on [Unit Test Bar and Standards](UnitTestBarAndStandards.md).
Add UITest docs (#439)
2019-07-17 01:22:59 +03:00
#### Q. What about UI tests?
Refer to the [UI Tests](../src/UITests/README.md) readme.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How do I go about making internal interfaces available for testing?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Please visit [Accessing Internals](AccessingInternals.md).
Replace URL with linked text in FAQ (#405) This is more aesthetically appealing. - Fix spelling error for "extenstions" - Fix spelling error for "vist"
2019-06-28 01:13:39 +03:00
#### Q. How do I go about debugging an extension during development?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
[Debugging Extensions](DebuggingExtensions.md) provides more detail.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. Is there anything that I need to support High Contrast?
Addressing PR comments
2019-01-31 02:40:41 +03:00
Excellent question. Please visit the [High Contrast Support](HighContrastSupport.md) page for more information.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. Where can I find out more about a specific rule?
Replace URL with linked text in FAQ (#405) This is more aesthetically appealing. - Fix spelling error for "extenstions" - Fix spelling error for "vist"
2019-06-28 01:13:39 +03:00
Accessibility Insights uses rules from [axe-windows](https://github.com/microsoft/axe-windows). Please refer to the docs folder there for an explanation of rules.
Placeholder linking to an explanation of the various rules.
2019-01-31 04:03:54 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. What scenarios must I test before creating a PR?
Addressing PR comments
2019-01-31 02:40:41 +03:00
All PRs need to be tested against the scenarios that are documented at [Test Scenarios](Scenarios.md).
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Addressing PR comments
2019-01-31 02:40:41 +03:00
If your PR includes UI changes please follow the additional instructions for UI changes in the [Test Scenarios](Scenarios.md) page.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. What happens after I submit a PR?
Improvements to FAQ and readme
2019-01-31 03:09:25 +03:00
All PRs kick off a build and the build status is visible in the PR checks section. Failures need to be addressed before the PR can be merged.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q.How do I go about adding telemetry for my changes?
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Please visit the [Telemetry Overview](TelemetryOverview.md) page on how to do so.
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How do I add a project to the solution?
Improving the FAQ.
2019-01-30 23:16:34 +03:00
Visit [Adding a new project](NewProject.md) for instructions.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Adding info about the cla.
2019-03-28 01:47:28 +03:00
#### Q. On my PR the "license/cla" check does not complete. What should I do?
Update docs/FAQ.md Co-Authored-By: flyingUnderTheRadar <45673569+flyingUnderTheRadar@users.noreply.github.com>
2019-03-28 02:30:17 +03:00
Make sure that you have signed our [CLA agreement](../Contributing.md). If you haven't, please sign the agreement, then close and reopen the PR. This will trigger a new build with the CLA agreement in place.
Adding info about the cla.
2019-03-28 01:47:28 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. How do I get in contact?
Updated links with the FWLinks (#105)
2019-02-25 22:54:41 +03:00
Please file a [Github Issue](https://github.com/Microsoft/accessibility-insights-windows/issues/new/choose). We actively monitor PRs and issues.
+FAQ for better discoverability of existing documentation & common questions.
2019-01-30 23:11:07 +03:00
Updating heading level and adding telemetry/msrc (#177) * Updating heading level and adding telemetry/msrc * After discussion with Risa, make the following doc changes: 1. Make the readme.txt for telemetry match the text used in the telemetry dialog 2. Update all of the .md files to use H2 as their highest index (GitHub already sets H1, which leads to AIWeb errors). 3. Add a code block around the code snippet in AccessingInternals.md (to prevent unintended H1 blocks there) 4. Replace a TBA with a link to the product page (this was overlooked when I changed the readme) * Fix 2-level jump in headers * Contirbuting.md needs to start at H2, not H1
2019-03-09 02:00:42 +03:00
#### Q. I encountered a bug. Where do I report it?
Improving the FAQ.
2019-01-30 23:16:34 +03:00
We use Github Issues for bug tracking.
Replace URL with linked text in FAQ (#405) This is more aesthetically appealing. - Fix spelling error for "extenstions" - Fix spelling error for "vist"
2019-06-28 01:13:39 +03:00
Visit the [issues](https://github.com/Microsoft/accessibility-insights-windows/issues?q=is%3Aissue+is%3Aopen%2Cclosed) page to see if an issue for it already exists.
Improving the FAQ.
2019-01-30 23:16:34 +03:00
Update docs/FAQ.md Co-Authored-By: flyingUnderTheRadar <45673569+flyingUnderTheRadar@users.noreply.github.com>
2019-03-28 02:30:17 +03:00
If it doesn't, feel free to [file an issue](https://github.com/Microsoft/accessibility-insights-windows/issues/new/choose).