Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Config Generation #42

Closed
Adrianzatreanu opened this issue Aug 19, 2016 · 12 comments · Fixed by #549
Closed

Document Config Generation #42

Adrianzatreanu opened this issue Aug 19, 2016 · 12 comments · Fixed by #549
Assignees

Comments

@Adrianzatreanu
Copy link
Contributor

From @sils1297 on May 14, 2016 18:51

Copied from original issue: coala/coala#2145

@Adrianzatreanu
Copy link
Contributor Author

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

@Adrianzatreanu
Copy link
Contributor Author

From @sils1297 on May 14, 2016 18:51

for linter

@Adrianzatreanu
Copy link
Contributor Author

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.

@Adrianzatreanu
Copy link
Contributor Author

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 ?

@Adrianzatreanu
Copy link
Contributor Author

From @AbdealiJK on May 30, 2016 18:3

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

@jayvdb
Copy link
Member

jayvdb commented Nov 23, 2017

Hmm.

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

@satwikkansal
Copy link
Member

satwikkansal commented Nov 24, 2017

So a page explaining what coala-quickstart does at http:https://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.

@jayvdb
Copy link
Member

jayvdb commented Apr 18, 2018

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

@jayvdb jayvdb assigned palash25 and ishanSrt and unassigned satwikkansal Apr 18, 2018
@jayvdb
Copy link
Member

jayvdb commented Apr 18, 2018

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.

@palash25
Copy link
Member

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.

@ishanSrt
Copy link

sounds good 👍

@jayvdb
Copy link
Member

jayvdb commented Apr 18, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

6 participants