Commit graph

14 commits

Author SHA1 Message Date
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
rhymes
1924a77a10 [DOC] Move architecture to technical overview (#4746) 2019-11-07 14:28:23 -05:00
Jenna Pederson
ee91310f3a Doc: Fix/clarify getting started docs (#4509) [ci skip] 2019-10-22 14:38:41 -04:00
Anna Anks Nowak
c4b5530e2e Add info about bumping API version to docs.dev (#4454)
* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]

* Add info about bumping API docs version requirement

* Fix Create pull request link by linking to the docs
2019-10-16 09:04:36 -04:00
Ben Halpern
3db3f6fdc2
Fix gotchas with color preview and some style adjustments and add documentation (#4322) 2019-10-08 21:32:31 -04:00
Ben Halpern
c0faa20c90
Add more info to architecture (#4233)
* Add more info to architecture

* Fix various typos and improve clarity in docs
2019-10-08 11:29:44 -04:00
Jacob Herrington
8cebfd415d [DOC] Update DEV onboarding documentation (#4215) 2019-10-03 16:38:28 -04:00
Jacob Herrington
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
Ben Halpern
cbef9ada79
Add some architecture docs (#4171) 2019-10-01 10:30:03 -04:00
Jess Lee
8e53ef0d8e clean up readme and docs (#3660)
* clean up readme and docs

* add missing files
2019-08-08 16:20:58 -03:00
Kitten King
6290451273 Fix Typos (#3510) 2019-07-22 12:56:48 -04:00
Conor Fischer
2a57e43bcb Fix broken doc links (#2945) [ci skip] 2019-05-24 12:31:18 -04:00
rhymes
9210f6793b Improvements on dev docs (#2616)
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -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