docbrown/docs/faqs.md
rhymes fb9a407b21 Adds Ruby source code documentation to docs.dev.to (#2656)
* Add YARD and plugins to generate source code doc

* Expose yard Ruby doc in gitdocs

* Add yard doc step to Travis

* Tell netlify to build the docs before deploying

* Add Gemfile for Ruby prerequisites and Makefile

* Makefile uses tabs, not spaces

* Build ruby-doc and then gitdocs

* Add recent Ruby version to make sure yard plugins work

* Switch Ruby to a pre-built version inside Netlify

* Add ActiveRecord for the yard-activerecord plugin

* Add Ruby doc header link and info to build it locally
2019-05-02 13:50:58 -04:00

14 lines
257 B
Markdown

---
title: FAQs
---
# Frequently Asked Questions
## How do I build my local copy of the Ruby source code documentation?
```shell
cd docs
make ruby-doc
```
Then open `.static/ruby-doc/index.html` in the `docs` directory and browse the Ruby documentation