Skip to content

Conversation

@s0ph1e
Copy link
Member

@s0ph1e s0ph1e commented Mar 6, 2017

No description provided.

@s0ph1e s0ph1e requested a review from aivus March 6, 2017 20:29
Copy link
Member

@aivus aivus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s0ph1e what do you think about moving option descriptions to separate file to not overload README file?

README.md Outdated
* [defaultFilename](#defaultfilename) - filename for index page
* [prettifyUrls](#prettifyurls) - prettify urls
* [ignoreErrors](#ignoreerrors) - whether to ignore errors on resource downloading
* [urlFilter](#urlfilter)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some description maybe?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, will add some description

@s0ph1e
Copy link
Member Author

s0ph1e commented Mar 7, 2017

@aivus I prefer to have documentation in one place instead of having a lot of files. And when everything is in one place it is easier to use Ctrl+F to search for something on page.
It is not overloaded from my point of view.

@s0ph1e
Copy link
Member Author

s0ph1e commented Mar 7, 2017

@aivus what do you think in general, is it better than current structure or not?

@aivus
Copy link
Member

aivus commented Mar 7, 2017

@s0ph1e looks like ok

@s0ph1e s0ph1e merged commit 423792d into master Mar 7, 2017
@s0ph1e s0ph1e deleted the update-readme branch March 7, 2017 19:30
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

Successfully merging this pull request may close these issues.

3 participants