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

Re-structure documentation #170

Open
colszowka opened this issue Oct 10, 2012 · 1 comment
Open

Re-structure documentation #170

colszowka opened this issue Oct 10, 2012 · 1 comment

Comments

@colszowka
Copy link
Collaborator

The README has become quite bloated. Though the introductory section seems to be quite simple to grasp, there's still a lot of support issues coming in from users, often pertaining to configuration trouble or missing the available config options.

It would probably be better for the README to explain the basics and then link to further guidelines sitting in docs/**/*.md and the API docs.

Having github/markup#84 fixed would be quite useful for this to avoid similar linking issues as with i.e. https://github.com/lsegal/yard or https://github.com/defunkt/resque, but for the time being the links probably should link straight to master on github.

@guiprav
Copy link

guiprav commented Oct 11, 2012

+1

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

No branches or pull requests

2 participants