Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for v4 #3611

Merged
merged 2 commits into from
Jun 7, 2018
Merged

Conversation

paulfalgout
Copy link
Member

@paulfalgout paulfalgout commented Jun 6, 2018

@marionettejs/marionette-core as promised I've finally finished doc modifications. I am well aware that this is a huge PR and likely unmanageable as far as reviewing. My suggestion would be to skim it, and unless there's anything big we can make changes in subsequent PRs as we alpha/beta v4.

There was one tiny functional code change explained on the commit: d4330ec

The other changes to src files are changes that are either code comment updates or URL updates for errors.

This work does a few things:

  • Updates md code samples to ES6
  • Adds a flow to the documentation such that you can start an installation and continue to click to somewhere meaningful in the docs.
  • Makes the docs match more of the code structure.. this is the big change and the important one.. we were getting a lot of duplication and it was hard to tell where to add docs when a feature was added. It isn't an exact science now, but it is much, much more clear where new docs will go.
  • Links thrown errors to docs about the error and makes a note about the error in the docs (we'll want to keep this up)
  • Updates everything for v4 changes
  • Standardizes similar language between related but different classes. The way we outline dealing with child views is now similar between the region and view docs. This helps the reader intuitively see the similarities, but highlights the differences.

What this doesn't do:

  • Address the v4 upgrade guide (might be best to leave this until we're ready for beta to be complete)
  • Address any other docs.. main readme, contribution, unit tests.. all of those are probably somewhat outdated.
  • Update the jsfiddle samples (as there's no public lib at the moment)

Once this gets in I'll make an alpha branch 🎉

If you want to visually click through: https://github.com/paulfalgout/backbone.marionette/blob/doc-updates-views/docs/basics.md

This is a non breaking change that prevents the method needing `this` or documenting `this.$container`
@paulfalgout paulfalgout added this to the v4.0 milestone Jun 6, 2018
@coveralls
Copy link

coveralls commented Jun 6, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling d7772bf on paulfalgout:doc-updates-views into 5e1466e on marionettejs:next.

@paulfalgout
Copy link
Member Author

I think this PR addresses: #3320 #3595 #3596 and #3606

@paulfalgout paulfalgout force-pushed the doc-updates-views branch 19 times, most recently from a216fe7 to 3760fda Compare June 6, 2018 15:20
Copy link
Contributor

@JSteunou JSteunou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a lot of work! I'm all in to merge this and fixing / rewording afterward, but even until this, it already looks amazing!

#### Adding unmanaged children

Unlike managed children there may be cases where you want to insert views to the results of the `CollectionView` after the
`collecton` changes, or after sorting and/or filtering. In these cases the solution might depend slightly on the features
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: collection changes,

Copy link
Collaborator

@blikblum blikblum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work

@blikblum
Copy link
Collaborator

blikblum commented Jun 7, 2018

Address the v4 upgrade guide (might be best to leave this until we're ready for beta to be complete)

I can help with that. See #3447. Must settle on a format

@paulfalgout paulfalgout merged commit b5aa8ce into marionettejs:next Jun 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants