leikind / wice_grid

A Rails grid plugin to create grids with sorting, pagination, and (automatically generated) filters
MIT License
537 stars 213 forks source link

Replaced README.rdoc to README.md #236

Closed ryanfox1985 closed 9 years ago

ryanfox1985 commented 9 years ago

Hi,

this is the initial commit, needs to be refactored.

Regards.

ryanfox1985 commented 9 years ago

Here you can see: https://github.com/ryanfox1985/wice_grid/tree/development

leikind commented 9 years ago

Please pay attention to lost markup. Search for +sometext+, and look at the text before Intro. It is broken

ryanfox1985 commented 9 years ago

Yes xD I need so time.

ryanfox1985 commented 9 years ago

what do you think now?

leikind commented 9 years ago

Better But the header is not what we had in README.rdoc. Look at the section before https://github.com/leikind/wice_grid

Also, look at section "Bug reports" attentively.

And the last thing: will it work with rake rdoc ? I doubt. I like to generate docs locally. Is there an alternative?

ryanfox1985 commented 9 years ago

Hi,

I added yard. Now generate the doc at ./doc folder. Take a look and tell me what do you think.

Needs some refactors. Regards.

leikind commented 9 years ago

I appreciate your work, but could you please do this based on the latest version of the README and CHANGELOG?

ryanfox1985 commented 9 years ago

Check now.

leikind commented 9 years ago

You write


This adds the config files:


YML and SASS are not config files! Please don't change the original text. Also, there is no app/assets/stylesheets/wice_grid.scss in https://github.com/leikind/wice_grid/tree/development

Unlike Github, Yardoc produces a pretty shitty output. Is there a way to have good yardoc output?

ryanfox1985 commented 9 years ago

I modified this line.

The standard from Github is Markdown. Sorry for your unlike with Yardoc, your are free for change the look xD, I don't waste my time with this.

I'm looking for add Rspec and test to your library.

Regards.

ryanfox1985 commented 9 years ago

And you need some refactors in README.md, you have duplicated things, a lot of lines, a lot examples.