search

rom-rb / rom-factory

Data generator with support for persistence backends
MIT License
83 stars 42 forks source link

Add some docs #58

Closed k0va1 closed 4 years ago

k0va1 commented 4 years ago

Hi, While I was using gem it was difficult to figure out how it works at first glance. So I decided to put together all the stuff. Any suggestions and comments are welcome

k0va1 commented 4 years ago

Thanks! I hope now it's OK :)

solnic commented 4 years ago

@k0va1 thanks again! we've got docs now :) https://rom-rb.org/learn/factory/0.10/ it's funny because yesterday I looked at this page thinking "oh man, I gotta write these docs" hah...

k0va1 commented 4 years ago

@solnic you're welcome) BTW, I've just checked the page https://rom-rb.org/learn/factory/0.10/#associations and came across a bug in associations section. The easiest way to fix it will be remove unordered list. But maybe it's a bug in theme

solnic commented 4 years ago

@k0va1 this looks like a mistake in md syntax

k0va1 commented 4 years ago

@solnic hm, it looks OK here https://github.com/rom-rb/rom-factory/pull/58/files?short_path=00ae0ee#diff-00ae0ee4ccfb1882896653c6c718be6c

solnic commented 4 years ago

@k0va1 I fixed it. It's because "```" needs an empty line. The MD parser the website uses is not the same as GH, so looking at GH formatting is not enough. Unfortunately we don't have (yet) a preview feature, but in the future it will be possible to preview a PR on the actual website (it's possible to automatically build and deploy a test version for a specific PR).

k0va1 commented 4 years ago

@solnic cool! Thanks for explaining the details :)