Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
.static VS Code Settings Update / Frontend Debug Documentation (#4346) Oct 10, 2019
backend Fix Algolia signup link. (#5100) Dec 13, 2019
design Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
frontend Add Next Tech Liquid Tag (#4958) [deploy] Dec 10, 2019
getting-started Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
installation Add redis container to docker-compose (#4965) Nov 29, 2019
internal Write docs on rolify admin workaround [ci skip] (#5078) Dec 13, 2019
technical-overview Fix Technical Overview links [ci skip] (#5084) Dec 12, 2019
tests Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
.gitdocs.json
.ruby-version Upgrade docs Ruby version to 2.6.5, same as the main app (#4872) Nov 21, 2019
Gemfile Upgrade docs Ruby version to 2.6.5, same as the main app (#4872) Nov 21, 2019
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) Aug 12, 2019
api_template.hbs Use server side comments for templates (#4123) Sep 27, 2019
api_v0.yml API docs updates (#4585) Oct 25, 2019
contributing.md Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
contributing_api.md Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
deploy-script.js Update Docs deploy command (#3940) Sep 4, 2019
deployment.md Replace Airbrake with Honeybadger (#5007) [deploy] Dec 5, 2019
faqs.md Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
licensing.md Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019
readme.md Write docs on rolify admin workaround [ci skip] (#5078) Dec 13, 2019
self-hosting.md Improve the clarity of the docs and fix Prettier config (#4899) Nov 26, 2019

readme.md

items
technical-overview
installation
getting-started
backend
frontend
internal
design
deployment.md
tests
contributing.md
contributing_api.md
faqs.md
licensing.md
self-hosting.md

Welcome to DEV's developer documentation

On this site you'll find instructions to setup a local instance of DEV, documentation on the architecture of DEV, how to contribute, and many other useful documents.

This documentation site is the product of a number of volunteer contributors working alongside the DEV Core Team, special thanks to all those who have contributed to the documentation.

Running the documentation locally

Like DEV, this site is open source and the code is hosted on GitHub. If you find any incorrect information, or a even a typo, we'd love to see a pull request. Follow these steps to get the documentation site running 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 should 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/

If you add new pages or rename existing pages, you'll need to restart the server for those changes to take effect.

Contributing to the docs

If you're looking for more information on contributing, check out the Contributing article.

You can’t perform that action at this time.