search

solnic / virtus

[DISCONTINUED ] Attributes on Steroids for Plain Old Ruby Objects
MIT License
3.77k stars 228 forks source link

Simplify README and port most of it into wiki pages #205

Open solnic opened 10 years ago

solnic commented 10 years ago

solnic commented 10 years ago

hey @elskwid any ideas how we could organise the wiki pages? I remember you mentioned you'd be interested in helping with docs too so I figured I'd ask you :smile:

elskwid commented 10 years ago

@solnic, I do have some ideas! You want this for 1.0.0 so how long do I have?

solnic commented 10 years ago

It's not like this issue would block the release...

On Wed, Oct 2, 2013 at 11:38 PM, Don Morrison notifications@github.com wrote:

@solnic, I do have some ideas! You want this for 1.0.0 so how long do I have?

Reply to this email directly or view it on GitHub: https://github.com/solnic/virtus/issues/205#issuecomment-25579332

elskwid commented 10 years ago

Yeah I know. I meant, give me a target so I can block out some time. I'll put my thoughts together tonight and start tomorrow.

solnic commented 10 years ago

The target is simple: rip README apart, leave the most basic example so that people can easily start using virtus using this example and leave a link to wiki for more advanced examples.

I haven't decided how to structure the wiki. I'm open for ideas. It seems like we could group things into sections like how to include virtus into models/objects/modules, how to configure them with a list of all supported options explaining what they mean etc. Then we need a section explaining how to declare attributes, again with all supported options (those partially overlap with options supported by module builder so it might be a good idea to just link to the first section for detailed info about options). How types are handled is also a bigger chunk of info that deserves a separate section IMO. Which types are supported etc. mostly focusing on EV, collections and hashes. How primitive types (string, integer etc) are handled can just mention that virtus uses coercible and point to its README (which I need to update btw haha). Then there's ValueObject which deserves a separate section too. I'm not sure where info about finalization should go, probably in the first section.

I'm also thinking about a section in wiki specifically for 'virtus use cases' / 'how-to'. You know what I mean? Basically examples of how you can solve specific problems with virtus.

solnic commented 10 years ago

@elskwid I want to release 1.0.0 next week as I'm running out of time, if we don't make it with the docs I will just push it with the current readme and we can improve it later.

elskwid commented 10 years ago

@solnic, I spent several hours going over the docs this last weekend. I have a solid idea how I'd like to handle our needs. I will start getting them updated and up on my fork. I'll ping you as they start to show up so you can review.

How about if I have them done for Wednesday?

solnic commented 10 years ago

That would be great!

On Tue, Oct 15, 2013 at 8:59 AM, Don Morrison notifications@github.com wrote:

@solnic, I spent several hours going over the docs this last weekend. I have a solid idea how I'd like to handle our needs. I will start getting them updated and up on my fork. I'll ping you as they start to show up so you can review.

How about if I have them done for Wednesday?

Reply to this email directly or view it on GitHub: https://github.com/solnic/virtus/issues/205#issuecomment-26312955

elskwid commented 10 years ago

Status update: The docs are coming along nicely. I will have a version branch for review ready for 2013-10-28.

elskwid commented 10 years ago

Status update: (so, I missed my date, by a LONG shot). Hackathon season is behind me and I will finish this up in the next day or so.