w3ctag / design-principles

A small-but-growing set of design principles collected by the TAG while reviewing specifications
https://w3ctag.github.io/design-principles
178 stars 46 forks source link

Move out most of "non-fully active" handling guide #392

Closed rakina closed 1 year ago

rakina commented 2 years ago

The guide is being moved to a separate "Supporting BFCached documents" doc, to keep the design principles doc short. Replaces the previous content with a short intro and link to the full guide (which is still in my personal repo). See also https://github.com/w3ctag/design-reviews/issues/628#issuecomment-1227165134 for context.


Preview | Diff

LeaVerou commented 2 years ago

Hi there, I noticed that the link to the new guide is TODO. I think we should not merge this until that is available, otherwise we're just removing useful guidance without pointing anywhere for finding it.

rakina commented 2 years ago

Yep, the plan is to land the BFCache Guide doc first before landing the update to these existing docs.

Is there a good way to get the BFCache Guide doc reviewed? Currently it lives in https://github.com/rakina/bfcache-guide and I can't really make a PR for it because it's a new doc... (How did the Promises guide get reviewed?)

rakina commented 2 years ago

Friendly ping for the review for this and the other PRs. Also still don't know where to put the new BFCache doc for review... (@domenic, how did you get to make the https://github.com/w3ctag/promises-guide repo?)

domenic commented 2 years ago

(@domenic, how did you get to make the https://github.com/w3ctag/promises-guide repo?)

I think I created a separate repo under my own GitHub, and eventually transferred it to the w3ctag. So you're on the right track...

cynthia commented 1 year ago

Sorry this took so long, overall the proposed changes look fine to us - and we'd like to do a review of the BFCache guide seprately.

As for that, the repository is here: https://github.com/w3ctag/bfcache-guide @rakina and @domenic should have write access (on top of the usual TAG suspects)

Wondering how we should review the bfcache-guide repository though, I suppose I could create a PR against the main branch so that we have something to review. Thoughts?

rakina commented 1 year ago

Thanks @cynthia and @torgo! Looks like https://github.com/w3ctag/bfcache-guide already has the doc committed so maybe we should move that into a separate branch and clear out the main branch, and then make a PR against the main branch?