docs: Octane and much polish and clarification #935
Conversation
chriskrycho
force-pushed
the
octane-docs
branch
from
93f53f2
to
99193e5
Compare
|
🤦♂ The commits are all there, but apparently there's a known issue where specifically for public repos a commit coming from an action won't trigger a Pages build: https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869 I'll see if I can come up with a workaround, but for now running |
|
Whaaaaaaaat. Deploy manually it is! |
- Add an empty stub for documenting legacy EmberObject support. This will subsume much of the existing content once reorganized. - Begin drafting an explanation of working with Glimmer components.
Co-Authored-By: Mike North <558005+mike-north@users.noreply.github.com>
Generate new routes for the new outline of the docs, and begin populating them with existing content or stubs for new content.
chriskrycho
force-pushed
the
octane-docs
branch
from
e6e4559
to
0fbadb8
Compare
|
I've updated and added a bunch of material and redeployed! (I have not yet integrated the suggestions above b/c my focus was on getting a bunch of the organization in place.) |
This content is out of date (in the Mirage case) and duplicated (in the case of the duplicate types info). Remove it!
- add a better introductory sentence - improve the paragraphing between lists - add missing links to pages
chriskrycho
force-pushed
the
octane-docs
branch
from
d2f1ebe
to
0f9f088
Compare
- change a list to a paragraph - improve the description of tradeoffs around approachs
chriskrycho
changed the title
|
@dfreeman @jamescdavis at this point, I think there's more value in getting these into the world than in thinking about trying to polish further first. They're already a year late. Better to get them up and then iterate on something and that way better serve end users. Assuming no 👎🏼 from either of you, I'll plan to merge this over the weekend and then we can keep making forward progress. We'll also need to coordinate getting the custom domain rejiggered for it, but that should be pretty easy. |
|
Agreed! LMK when we're ready to cut over and I'll repoint the domain. |
This now migrates everything to GitBook, and covers both Octane and Classic. This is not exhaustive, but it is a reasonable starting point, and we can iterate from here.