documentation icon indicating copy to clipboard operation
documentation copied to clipboard

The official documentation for coala

Results 66 documentation issues
Sort by recently updated
recently updated
newest added

Missing documentation caused the confusion in https://github.com/coala/coala/issues/4102 :)

area/documentation

Greetings Coala Team! I would like to help translating the documentation of Coala available at http://docs.coala.io/en/latest/ into spanish language. In order to do so, I have a couple of questions....

area/documentation
status/needs discussion

Users want to know whether coala will enforce a specific widely used style guideline. We should have a documentation about each of these style guidelines, and tell them which bears...

I found no documentation or hint, that you can use coala-ci and coala-json instead of pure coala to get better formatted coala output. Please add in a suitable place or...

cool and awesome
difficulty/low
importance/high

_From @Uran198 on March 8, 2016 18:25_ Only in some files there is use of [function annotations](https://www.python.org/dev/peps/pep-3107/). It would be good to either use annotations everywhere or don't use them...

area/documentation
importance/low
difficulty/low
hacktoberfest

http://docs.coala.io/en/latest/Users/Docker_Image.html#coala-on-gitlab-ci mentions invoking `pip install ..`. This line is not necessary difficulty/newcomer Opened by @jayvdb at [Gitter](https://gitter.im/coala/coala?at=59fd149919147ac323190f77)

difficulty/newcomer

Same as https://github.com/coala/projects/issues/393 , AGPL isnt very good for text, and is a border-line problem when copying CC-BY-SA text from other websites, as occurred in https://github.com/coala/documentation/issues/482.

_From @Makman2 on June 2, 2016 23:21_ Many people seem to struggle with the fact that there's no shell expansion any more, quotes and stuff are removed as they are...

area/documentation
area/bears

_From @Makman2 on June 3, 2016 23:53_ On windows sometimes pip is screwed, we maybe should document the usage of `python -m pip` then. Though I'm not sure, it's in...

area/documentation

Unarchived links can be a problem if the site goes down and we can't see the site anymore. We can use MementoBear to handle this problem, it detects unarchived links,...

difficulty/low
status/stale