Backbone.js style docs #236

Merged
merged 13 commits into from Feb 15, 2013

Conversation

Projects
None yet
4 participants
@jayd3e
Contributor

jayd3e commented Dec 29, 2012

Closed #230, so I could reopen the same pull request here with the correct branch. The docs are pretty solid now imo. I would say let's get them in master, so people can start working on them there, as opposed to in the README.md. The only major thing that needs to be changed, is we need to link to the development and production versions of Backbone-relational.js on the main page. Is there standard location that I can link to? I couldn't find one.

You can see the docs in action here.

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Jan 6, 2013

Owner

Thanks a lot! Some remarks on the current version:

  • the docs reference the "Q and A" in one place, but this isn't present (probably rightfully so, since it looks a bit outdated to me)
  • some of the small examples are missing, which I do think are illuminating?
  • the difference between the instance and "class" methods on Backbone.RelationalModel isn't clear from the docs?
Owner

PaulUithol commented Jan 6, 2013

Thanks a lot! Some remarks on the current version:

  • the docs reference the "Q and A" in one place, but this isn't present (probably rightfully so, since it looks a bit outdated to me)
  • some of the small examples are missing, which I do think are illuminating?
  • the difference between the instance and "class" methods on Backbone.RelationalModel isn't clear from the docs?
@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Jan 16, 2013

Owner

Should be okay to use the backbone docs style, see documentcloud/backbone#2077 .

Owner

PaulUithol commented Jan 16, 2013

Should be okay to use the backbone docs style, see documentcloud/backbone#2077 .

@jayd3e

This comment has been minimized.

Show comment
Hide comment
@jayd3e

jayd3e Jan 16, 2013

Contributor

kk awesome. Haven't had time recently, but I'll make a point to finish it up tonight, so we can get it merged.

Contributor

jayd3e commented Jan 16, 2013

kk awesome. Haven't had time recently, but I'll make a point to finish it up tonight, so we can get it merged.

Included the missing code examples, as well as the excluded 'Examples…
…' and 'Under the Hood' sections. Additionally, made it more clear as to which methods are Relational Model type methods and which are instance methods.
@jayd3e

This comment has been minimized.

Show comment
Hide comment
@jayd3e

jayd3e Jan 17, 2013

Contributor

So I think this is a good start, and I would say is ready to go live. The only real thing that needs to happen is the development and production buttons should link to the actual downloads, which they currently do not.

Contributor

jayd3e commented Jan 17, 2013

So I think this is a good start, and I would say is ready to go live. The only real thing that needs to happen is the development and production buttons should link to the actual downloads, which they currently do not.

@jayd3e

This comment has been minimized.

Show comment
Hide comment
@jayd3e

jayd3e Jan 31, 2013

Contributor

@PaulUithol had a chance to look at these?

Contributor

jayd3e commented Jan 31, 2013

@PaulUithol had a chance to look at these?

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Feb 15, 2013

Owner

Sorry, I must have missed some github mail notifications! Merging.

Owner

PaulUithol commented Feb 15, 2013

Sorry, I must have missed some github mail notifications! Merging.

PaulUithol added a commit that referenced this pull request Feb 15, 2013

@PaulUithol PaulUithol merged commit 30ddf91 into PaulUithol:master Feb 15, 2013

@philfreo

This comment has been minimized.

Show comment
Hide comment
@philfreo

philfreo Feb 15, 2013

Collaborator

If we have these docs then the README should be cleared out (also make sure the latest README changes made it into this https://github.com/PaulUithol/Backbone-relational/commits/master/README.md )

Collaborator

philfreo commented Feb 15, 2013

If we have these docs then the README should be cleared out (also make sure the latest README changes made it into this https://github.com/PaulUithol/Backbone-relational/commits/master/README.md )

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Feb 15, 2013

Owner

Yeah, I was planning to do that. Only thing is that I now shoved everything into master instead of gh-pages, by pushing the merge button here.. hmm.

Owner

PaulUithol commented Feb 15, 2013

Yeah, I was planning to do that. Only thing is that I now shoved everything into master instead of gh-pages, by pushing the merge button here.. hmm.

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Feb 15, 2013

Owner

Alright, seems to be working fine, see http://backbonerelational.org !

Owner

PaulUithol commented Feb 15, 2013

Alright, seems to be working fine, see http://backbonerelational.org !

@jayd3e

This comment has been minimized.

Show comment
Hide comment
@jayd3e

jayd3e Feb 16, 2013

Contributor

Awesome, thanks for merging this guys.

Contributor

jayd3e commented Feb 16, 2013

Awesome, thanks for merging this guys.

@philfreo

This comment has been minimized.

Show comment
Hide comment
@philfreo

philfreo Feb 18, 2013

Collaborator

You should put the link to the docs at the top of the github right under the description (they have a field for url)

Collaborator

philfreo commented Feb 18, 2013

You should put the link to the docs at the top of the github right under the description (they have a field for url)

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Feb 19, 2013

Owner

Ah, completely forgot about the existence of that field. Done.

@DouweM : for some reason, going to http://www.backbonerelational.org fails. Could you make that redirect to http://backbonerelational.org?

Owner

PaulUithol commented Feb 19, 2013

Ah, completely forgot about the existence of that field. Done.

@DouweM : for some reason, going to http://www.backbonerelational.org fails. Could you make that redirect to http://backbonerelational.org?

@DouweM

This comment has been minimized.

Show comment
Hide comment
@DouweM

DouweM Feb 19, 2013

Collaborator

@PaulUithol I've made the change. It should be working shortly, depending on your DNS cache.

Collaborator

DouweM commented Feb 19, 2013

@PaulUithol I've made the change. It should be working shortly, depending on your DNS cache.

@PaulUithol

This comment has been minimized.

Show comment
Hide comment
@PaulUithol

PaulUithol Feb 19, 2013

Owner

Yep, works for me, thanks. How do you like the docs?

Owner

PaulUithol commented Feb 19, 2013

Yep, works for me, thanks. How do you like the docs?

@DouweM

This comment has been minimized.

Show comment
Hide comment
@DouweM

DouweM Feb 19, 2013

Collaborator

I like it a lot! It's definitely a lot nicer to read through than the readme was.

Collaborator

DouweM commented Feb 19, 2013

I like it a lot! It's definitely a lot nicer to read through than the readme was.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment