Skip to content

Break out README contents into GitBook docs - #286

Merged
dfreeman merged 1 commit into
mainfrom
docs
Apr 7, 2022
Merged

dfreeman merged 1 commit into
mainfrom
docs

Conversation

@dfreeman

@dfreeman dfreeman commented Apr 7, 2022 •

Copy link
Copy Markdown
Contributor

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.md and 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 for ember-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/

@dfreeman dfreeman added the documentation Improvements or additions to documentation label Apr 7, 2022
@dfreeman
dfreeman force-pushed the docs branch 2 times, most recently from 0ce6e0d to d5a1ff8 Compare April 7, 2022 14:34
@dfreeman
dfreeman merged commit 16a5342 into main Apr 7, 2022
@dfreeman
dfreeman deleted the docs branch April 7, 2022 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant