search

tc39 / ecmarkup

An HTML superset/Markdown subset source format for ECMAScript and related specifications
https://tc39.es/ecmarkup/
MIT License
216 stars 62 forks source link

Suggestion: add metadata field for marking a proposal as outdated / merged into upstream spec #236

Open mathiasbynens opened 4 years ago

mathiasbynens commented 4 years ago

For proposals that have reached stage 4, it seems worthwhile to show a big warning banner at the top of the rendered spec text, urging folks to no longer reference the proposal itself but instead link to the integrated version into the spec text. Something like this (but with better phrasing):

Note: This proposal has been accepted into the upstream ECMAScript specification — please update your references to point there. This snapshot is only kept for historical purposes.

For styling inspiration, here's a similar example for a CSS spec: https://drafts.csswg.org/date/2018-07-09T23:26:30/css-box-3/

Currently, proposal authors can manually implement something like this, but it would be helpful if there was a standard mechanism to accomplish this.

We could either introduce a new metadata field (maybe deprecated: true?), or we could do this automatically when both status: proposal and stage: 4 are set in the metadata.

cc @tc39/ecma262-editors

mathiasbynens commented 4 years ago

I've manually added an example to the Promise.any proposal: https://tc39.es/proposal-promise-any/

ljharb commented 4 years ago

Doing it automatically sounds perfect; nothing at stage 4 is ever not going to need this warning.