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

Provide a single source of documentation on settings #26

Closed
dchekanov opened this issue May 5, 2014 · 4 comments
Closed

Provide a single source of documentation on settings #26

dchekanov opened this issue May 5, 2014 · 4 comments

Comments

@dchekanov
Copy link
Contributor

Currently settings are described in at least 3 locations:

  • Pages - index (short)
  • Pages - "Settings" (extensive)
  • Project - readme (short)

It would be easier for new users and documentation maintainers if there will be only one source (Pages - "Settings", probably). Other places can have links for that source.

@dchekanov
Copy link
Contributor Author

Sachin, the issue I've described above is still valid. Could you please comment on why you've closed it?

@sachinchoolur
Copy link
Owner

I thought we can keep index and readme page settings for quick reference with default values and settings page for detailed reference. what you think?

Once again thank you for your contribution.

@dchekanov
Copy link
Contributor Author

You are right, it might be easier/faster for new users to get started by having such condensed examples. I'll update them to match the "Settings" page and add a link, if you don't mind.

@sachinchoolur
Copy link
Owner

Sure. Please follow the same style of index page.
Something like this https://github.com/wbotelhos/raty#options

Thanks in advance .

This was referenced May 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants