Document Config Generation about documentation HOT 12 CLOSED

A very basic page. Just get the ball rolling. Negotiate who does it. We'll get it merged quick, and then create new issues for extra things that should be added.

from documentation.

New pages are better done by a single person. @palash25 , if you can get a basic version done, @ishanSrt can be the initial reviewer.

from documentation.

From @gitmate-bot on May 14, 2016 18:51

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

from documentation.

From @sils1297 on May 14, 2016 18:51

for linter

from documentation.

From @AbdealiJK on May 30, 2016 16:44

I think the best way is to make a website which has a table of the configs being used right now, the documentation related to that param, and the bears it's being used in. This website/webpage should have a search box for easy searching and should be auto generated from the bears itself.
This webpage would help third party bear writers too ! And would be a really cool one-page documentation of all the "features" coala provides. And also which bears it provides them in.

Possible methods of doing this:

• Make a parser using our documentation parsing routines and create a webpage with it. And then link this in the docs.
• Configure sphinx to autogenerate this (somehow? if it's possible...) I think sphinx is pretty flexible ?

I think this page should reside in our documentation and should be "autogenerated" in every readthedocs build.

from documentation.

From @sils1297 on May 30, 2016 16:54

@AbdealiJK are you sure this comment was on the right issue? Did you mean to comment on coala/coala-bears#460 ?

from documentation.

From @AbdealiJK on May 30, 2016 18:3

Yes indeed. I confused the issues.
It was meant for coala/coala-bears#460

from documentation.

Hmm.

There should be a documentation page about coala-quickstart.
Assigning to get that started properly, and this extremely old issue closed.

from documentation.

So a page explaining what coala-quickstart does at http://docs.coala.io (i.e. here)? I think that's a good idea, most people don't use quickstart because they aren't aware of it.

from documentation.

@satwikkansal , yes, but lets re-assign this again.

from documentation.

A basic layout for the quickstart.rst could be

• Installation
• Features
• Usage

We can distribute these sections amongst ourselves @ishanSrt
Let me know if I have missed something.

from documentation.

sounds good 👍

from documentation.