Commit graph

7 commits

Author SHA1 Message Date
rhymes
3e8e7fb093
Add troubleshooting section to docs and restore hidden sections (#6231) 2020-02-24 13:37:52 -05:00
rhymes
9153f61ef8
Optionally log to stdout (#6230) 2020-02-21 13:56:39 -05:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00
Jacob Herrington
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
Robin
880655b388 Add AWS install error to FAQ & update gitignore(#3871) [ci skip] 2019-08-29 10:28:13 -04:00
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
Andrew Brown
30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00