Updated shell add-on docs to reflect recent updates

indiana-university / rivet-docs

Website and documentation for Rivet, Indiana University’s design system for web application development

https://rivet.iu.edu/

BSD 3-Clause "New" or "Revised" License

7 stars 3 forks source link

Updated shell add-on docs to reflect recent updates #83

Closed levimcg closed 5 years ago

levimcg commented 5 years ago

This PR updated she documentation for the shell add-on based on the new 1.0.0 version.

@scottanthonymurray the content could probably use a review when you get a chance, as I've rewritten some of it.

scottanthonymurray commented 5 years ago

@levimcg I pushed my first take of revisions, but I have two questions:

How would you feel about renaming .rvt-shell__stage--subtle to .rvt-shell__stage--gray? I think that might communicate what the class does more clearly.
How would you feel about renaming .rvt-shell--reverse to .rvt-shell--right-sidebar or similar, for the same reason?

I can go ahead and open PRs on the rivet-shell repo if these changes sound alright. Thanks!

levimcg commented 5 years ago

@scottanthonymurray I think both of those sound like good changes. Let's go ahead and do that. so that we don't have to do another major release since that would technically be a breaking change, let's add those as duplicates/alias class names to the old ones and put a note to deprecate the old class names in the next major version. Does that make sense?

scottanthonymurray commented 5 years ago

@levimcg Perfect! I'll get a PR opened here shortly.