[editorial] Reorganise Readmes & spec introduction #965
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While looking for a place for an MF2 explainer and looking at what text we had already available, I think the editorial reorg proposed here would clarify things quite a bit. The end result here would be (links to this PR's versions):
/README.mddescribes the working group and its processes/spec/README.mdholds the ToC for the spec, along with a general introduction to MF2/spec/intro.mdis the actual "Introduction" section of the specI believe this arrangement would be clearer to a newcomer, and keep separate concepts more clearly separate. Note that as a result, the
/spec/README.mdfile would not be considered a part of the actual spec.The only changes to the text that are made here are fixes to links due to moved contents, and a small cleanup of the ToC (which had bad links and was missing the appendices), so I'm marking this as
editorialandfast-track.If this rearrangement is accepted, it becomes much easier to iterate on
/spec/README.mdas an explainer for the spec.