Re: [whatwg/streams] Switching to Web IDL (#963)

Whatever changes you end up making, please consider making an effort to preserve the existing fragment IDs. Either that or please make sure to give @whatwg/documentation a heads-up if you do end up needing to break them.

The reason I ask that is, MDN docs have already been written for API, and the MDN articles have links to the existing fragment IDs. So if the fragment IDs change, then all those links break.

In general it’d be nice if editors could keep that consideration in mind when making changes. Maybe it would help to think of it in terms of there being a “docs API” that’s bound to the fragment IDs that exist at the time when the docs are written — so if any fragment IDs change, that’s essentially a breaking change to that “docs API” that should be avoided if possible.

(P.S. I’m really happy about this actual substance of this planned change.)

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/streams/issues/963#issuecomment-437366548