Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Backbone.js style docs #236

Merged
merged 13 commits into from

4 participants

@jayd3e

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
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?
@PaulUithol
Owner

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

@jayd3e

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

@jayd3e jayd3e 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.
2a68433
@jayd3e

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

@PaulUithol had a chance to look at these?

@PaulUithol
Owner

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

@PaulUithol PaulUithol merged commit 30ddf91 into from
@philfreo
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 )

@PaulUithol
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.

@PaulUithol
Owner

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

@jayd3e

Awesome, thanks for merging this guys.

@philfreo
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)

@PaulUithol
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?

@DouweM
Collaborator

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

@PaulUithol
Owner

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

@DouweM
Collaborator

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
Commits on Aug 6, 2012
Commits on Dec 20, 2012
  1. @jayd3e
  2. @jayd3e

    Fixed static routes issue.

    jayd3e authored
Commits on Dec 21, 2012
  1. @jayd3e
Commits on Dec 24, 2012
  1. @jayd3e

    Fixed some links

    jayd3e authored
  2. @jayd3e
  3. @jayd3e
  4. @jayd3e
Commits on Dec 29, 2012
  1. @jayd3e
  2. @jayd3e

    Fixed a link.

    jayd3e authored
  3. @jayd3e
  4. @jayd3e

    Fixed some static imports.

    jayd3e authored
Commits on Jan 17, 2013
  1. @jayd3e

    Included the missing code examples, as well as the excluded 'Examples…

    jayd3e authored
    …' and 'Under the Hood' sections. Additionally, made it more clear as to which methods are Relational Model type methods and which are instance methods.
Something went wrong with that request. Please try again.