c6c5421163
* Add jext-axe package and introduce a11y testing Automated a11y testing is NOT comprehensive. We cannot expect this to even scratch the surface of potential a11y issues. However, we can expect to find a percentage of issues that are currently flying under the radar. Adopting some automation around a11y testing also allows us to use CI to find a11y regressions -- which should be really handy. I've never really used Jest before, and Preact seems to make it a little more complicated, but as far as I can tell, this is a decent way to add at least some minor automated a11y testing. * Add doc about automated a11y tests |
||
|---|---|---|
| .. | ||
| .static | ||
| backend | ||
| design | ||
| frontend | ||
| getting-started | ||
| installation | ||
| technical-overview | ||
| tests | ||
| .gitdocs.json | ||
| .ruby-version | ||
| api_template.hbs | ||
| api_v0.yml | ||
| contributing.md | ||
| contributing_api.md | ||
| deploy-script.js | ||
| deployment.md | ||
| faqs.md | ||
| Gemfile | ||
| licensing.md | ||
| Makefile | ||
| readme.md | ||
| self-hosting.md | ||
| items | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Welcome to DEV's developer documentation
Here you can find instructions on how to setup your own local copy of DEV, how to navigate the code, how to contribute, and how to troubleshoot issues, among other things.
Running the documentation locally
DEV's documentation is built with GitDocs NodeJS library.
The first step to running the documentations locally is to install the GitDocs package globally.
With npm:
npm install gitdocs -g
Alternatively, you can use Yarn:
yarn global add gitdocs
Once installed, you can run gitdocs serve from the root of the dev.to project or from the /docs directory.
gitdocs serve
This will start a server where you can browse the documentation: http://localhost:8000/
When you add new markdown pages or rename existing ones, you'll have to restart the server before you notice any changes.
Contributing to the docs
If you're looking for more information on contributing, check out the Contributing article.