Break out README contents into GitBook docs #286
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
dfreeman
force-pushed
the
docs
branch
2 times, most recently
from
0ce6e0d to
d5a1ff8
Compare
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.
With the work in #283 and #285 landing soon, we need a place to put a migration guide for moving from the old environment-specific reexports and legacy signature formats to using native imports and the finalized signature format from emberjs/rfcs#748.
The README is already massive, so it clearly doesn't make sense to incorporate yet another thing there. We could just make a
MIGRATING.mdand call it a day, but this seemed like a good opportunity to break apart the existing docs into separate pages to publish on GitBook the same way we do forember-cli-typescript.There's plenty of cleanup and improvements we could make to these docs, but the goal of this initial pass is just to take the existing content and structure it slightly more cleanly. The content is essentially just what's in the README today, with minor modifications for a few things like code snippets to make them render better in GitBook.
This draft is currently live at https://typed-ember.gitbook.io/glint/