Restructure design docs #178
Merged
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
As per WebAssembly/design#1349, we don't want to keep most of the design docs at the top level as they're out of date. Rather than getting rid of all of them at once, I've set up redirects for design docs that have explicit up-to-date versions (such as Binary Encoding, Text Format, Semantics, etc.), as well as for couple of docs that are no longer of interest - for those I'm redirecting to Markdown files in the original repo just so that URLs keep working. For a few docs still under the question of whether they should be pointing to better resources or updated themselves, I'm currently keeping them in the sidebar, but merging Docs & FAQ sections together to reduce the clutter.
Before
After
|
|
@binji @tschneidereit Ping? |
|
I guess I'll just go for it. |
binji
reviewed
Jul 9, 2020
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.
As per WebAssembly/design#1349, we don't want to keep most of the design docs at the top level as they're out of date.
Rather than getting rid of all of them at once, I've set up redirects for design docs that have explicit up-to-date versions (such as Binary Encoding, Text Format, Semantics, etc.), as well as for couple of docs that are no longer of interest - for those I'm redirecting to Markdown files in the original repo just so that URLs keep working.
For a few docs still under the question of whether they should be pointing to better resources or updated themselves, I'm currently keeping them in the sidebar, but merging Docs & FAQ sections together to reduce the clutter.