maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2988 commits 1 branch 0 tags 1.6 GiB
Commit graph

96 commits

Author SHA1 Message Date
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
Enrico Grillo
ccfae978b5 [DOC] Standardize punctuation, period (#4176) [ci skip] 2019-10-03 11:54:04 -04:00
Jacob Herrington
fa3612abf9 Fix technical overview doc layout [ci skip] (#4201) 2019-10-03 11:07:54 -04:00
Enrico Grillo
f3417d7ecb [DOC] Remove repetitive phrasing to improve readability (#4175) [ci skip] 2019-10-01 16:34:49 -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
rhymes
8a5fb23335 Use server side comments for templates (#4123) 2019-09-27 10:10:30 -04:00
rhymes
e6100dd400 Fix tags format in Article create API (#4075) [ci skip] 2019-09-20 10:14:41 -04:00
rhymes
02b5bb7d78 API: add doc for webhooks index (#4056) 
* Remove updated_at and use the same format for dates

* Add API docs for API /webhooks index
 2019-09-18 09:48:33 -07:00
Dhananjay
ac5509e181 Update image of Algolia backend docs (#3956) [ci skip] 2019-09-09 09:45:52 -04:00
rhymes
3a0dc13fc7 Replace "access token" with "API Key" (#3960) [ci skip] 2019-09-06 09:08:39 -04:00
rhymes
2e5a847ab8 API: /api/articles/me defaults to published articles (#3937) 
* /api/articles/me defaults to published articles

We want to make it explicit to retrieve unpublished articles, this change defaults `/api/articles/me` to only published articles, also adds `/api/articles/me/published`, `/api/articles/me/unpublished` and `/api/articles/me/all` to make requests more explicit.

* Refactor /me logic into a case switch
 2019-09-04 14:02:13 -04:00
Andy Zhao
f5e61fdae2 Update Docs deploy command (#3940) 
Use make build instead of only gitdocs command
 2019-09-04 09:29:49 -04:00
Andy Zhao
dd62a321d1 Add Setup for storybook.dev.to (#3885) 
* WIP test custom deploy script

* Add console logs

* Use common JS require instead of import

* WIP

* Use proper names

* Move back one directory...?

* Add npm install?

* Remove console logs

* Refactor a bit
 2019-09-03 16:49:37 -04:00
rhymes
0bafec4b4b DOC: Fix aggregated query to avoid deprecation (#3904) [ci skip] 2019-09-03 15:49:26 -04:00
rhymes
676cf002bd Webhooks: API fixes and docs (#3901) 
* Fix webhook API and add POST /api/webhooks docs

* Document GET /api/webhooks/:id

* Fix DELETE /api/webhooks/{id} and document it

* Add proper 404 specs
 2019-09-03 10:41:23 -04:00
Jean-Michel Fayard
4af02c8a48 Support for runnable kotlin snippets #3776 (#3801) 2019-08-29 16:06:17 -04:00
Robin
880655b388 Add AWS install error to FAQ & update gitignore(#3871) [ci skip] 2019-08-29 10:28:13 -04:00
Mario See
59217d76a7 Add scheduled Job doc (#3847) [ci skip] 2019-08-27 16:18:10 -04:00
Yash Dave
eccca28ee1 Update backend's readme filename (#3824) [ci skip] 2019-08-26 17:47:59 -04:00
not-a-patch
4243510f87 Backend Docs: roles.md #3737 (#3827) 2019-08-26 14:50:39 -04:00
not-a-patch
e9c33f4aea Backend docs: github authentication updated (#3814) 
- first item says "sign in" when it actually links you to
   creation of a OAuth application
 2019-08-23 17:11:22 -04:00
Yash Dave
0a9dc547d0 Updates Docs -> Installation -> Windows -> Possible error messages (#3804) 
Adds solution for the command 'bin/setup' failing while trying to install
'cld-0.8.0' due to absence of 'aclocal-1.10' and 'automake-1.10'. Provides
commands to install 'automake-1.10' from 'ftp.gnu.org' which fixes the problem.

Signed-off-by: Amorpheuz <mail2ypd@gmail.com>
 2019-08-22 15:56:40 -04:00
Peter Frank
eaf2a0840c Update docs (#3717) 
- Added information re: design components
- Added license info to "self hosting" section
 2019-08-14 13:04:04 -04:00
Esquith Allen
4f94889524 Add notification section to docs (#3681) 2019-08-13 10:25:53 -03:00
rhymes
e9db50b7c9 API docs: Document OAuth2 and /api/articles/me (#3707) 2019-08-12 16:00:12 -04:00
Esquith Allen
f545ebf7bb Adjust Algolia documentation (#3680) [ci skip] 2019-08-12 11:56:22 -04:00
rhymes
35526bef9b API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -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
Ryan Wang
a1580b4bbf expand common errors on macOS install (#3337) 
* expand common errors on macOS install

* edit postgresql restart to easiser command
 2019-07-01 08:17:09 -04:00
Branko Arnaudovski
1d2e9ff868 Docs: Change admin role tag information (#3323) [ci skip] 2019-06-27 18:06:42 -04:00
Mac Siri
de2bf910fd
Update doc on statement_timeout errors (#3248) [ci skip] 2019-06-20 13:36:40 -04:00
Mazen Touati
d5869a3b99 Add a possible error resolution for windows installation (#3178) 2019-06-16 00:45:26 -04:00
Curtis Maloney
8d50956f1a Optimise images (#2966) 2019-05-30 17:37:10 -04:00
Conor Fischer
2a57e43bcb Fix broken doc links (#2945) [ci skip] 2019-05-24 12:31:18 -04:00
rhymes
66ddcbca02 Upgrade rubocop and rubocop-performance (#2802) [ci skip] 2019-05-13 19:21:24 -04:00
Mohammadjavad Raadi
bfda378ff8 Docs: Add themeable styling documentation using SASS mixins (#2780) 2019-05-10 12:55:16 -04:00
Alireza Zekavat Fetrat
e53ca14bdc Fix broken gitdoc links (#2781) 2019-05-10 11:26:10 -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
rhymes
56e13d00f0 Upgrade Ruby to 2.6.3 (#2649) 2019-05-02 12:06: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
Nick Taylor
573cc2eb1b Added more to the rbenv troubleshooting section. (#2479) 2019-04-20 09:21:03 -04:00
Jess Lee
810352766d Update gitdocs (#2500) 2019-04-19 16:05:13 -04:00
Nick Taylor
9007b80356 Added troubleshooting for byebug without readline issue (#2481) 
* Added troubleshooting for byebug withouout readline issue.

* Genericized version number for error/solution.
 2019-04-19 12:34:29 -04:00
Nick Taylor
c2a9816f63 There are installation sections for other OSes now. (#2480) 2019-04-18 09:41:42 -04:00
rhymes
8e6ca966ed Switch from chromedriver-helper to webdrivers (#2465) [ci skip] 2019-04-16 13:46:23 -04:00
Abraham Williams
fdd18e6bb1 Simplify development setup (#2143) 2019-03-25 12:53:39 -04:00