spec icon indicating copy to clipboard operation
spec copied to clipboard

Wording of README in proposals directory is misleading.

Open fgmccabe opened this issue 1 year ago • 6 comments

It speaks about obsolete proposals. However, this directory is also where proposal authors develop their own proposals .. which are definitely not obsolete.

IMO, this is a side-effect of the whole 'fork the main repo' approach to developing proposals.

fgmccabe avatar Apr 22 '24 23:04 fgmccabe

Do you mean that proposals/README.md doesn't make sense when it's a sibling of proposals/my-active-proposal in the my-active-proposal repo? The version specifically in the spec repo seems fine as long as its scope is considered to be limited to the upstream spec repo.

tlively avatar Apr 22 '24 23:04 tlively

That is right.

fgmccabe avatar Apr 22 '24 23:04 fgmccabe

I'm not sure there's much we can do about this short of changing the proposal workflow to not involve forking the spec.

On the one hand, proposal authors can certainly change this file to say that their proposal is not obsolete, but on the other hand that would probably cause more trouble than it's worth when merging the finished proposal back into the spec.

In practice I'm not sure this is much of an issue because top-level proposal READMEs often link directly to the relevant Overview.md. I'm not sure I've ever even looked at proposals/README.md before this 😅

tlively avatar Apr 22 '24 23:04 tlively

Nothing prevents a proposal champion from modifying this file in their fork, as long as they undo that in the final merge PR. Hence I'm with @tlively, I don't think there is a problem here, nor is it actionable.

rossberg avatar Apr 23 '24 01:04 rossberg

A follow-up: wht happens to all these explainers once a proposal is merged?

fgmccabe avatar Apr 23 '24 15:04 fgmccabe

The proposal directories are merged in unchanged and the overviews become historical documents. For example the multivalue explainer is here: https://github.com/WebAssembly/spec/blob/main/proposals/multi-value/Overview.md. These historical explainers are what this README is referring to.

tlively avatar Apr 23 '24 15:04 tlively

The questions here appear to all be answered; if there are further questions, please file new issues!

sunfishcode avatar Dec 06 '24 17:12 sunfishcode