Quickstart docsify-powered documentation #451
Conversation
phndiaye
force-pushed
the
enhancement/docs
branch
from
2b64d67
to
c0ed61c
Compare
phndiaye
changed the title
phndiaye
force-pushed
the
enhancement/docs
branch
from
c0ed61c
to
5e22d1a
Compare
|
@phndiaye any chance you could rebase against master please and resolve the current conflict? |
phndiaye
force-pushed
the
enhancement/docs
branch
from
3d1ade7
to
2776088
Compare
|
@patocallaghan Updated :) the last updates in the README were about using newer syntax for models, which is now done in the doc itself |
docs/.nojekyll
Outdated
There was a problem hiding this comment.
Any idea what this file is required for?
There was a problem hiding this comment.
It's because Jekyll (through Github pages) interprets files starting with a leading _ as "special" and this file bypasses that behaviour.
| - ⭐ Works out of the box with your existing serializers and adapters | ||
| - 💎 Multiple build strategies | ||
| - 🕵️ Intercept and spy on Store requests | ||
| - 🕐 Slow down response times |
There was a problem hiding this comment.
Could we add links to all of the other pages until a time we get the site online into a public site? When we merge this PR the docs will only be available in these markdown files and won't be that discoverable
There was a problem hiding this comment.
@patocallaghan Sorry for the delay here :/ finally added a table of content to discover the documentation from the repo itself
phndiaye
force-pushed
the
enhancement/docs
branch
from
7e84730
to
ca439d5
Compare
Related to: #450
Rendered
This is a quickstart of the documentation update using Docsify. Basically all the content of the README has been moved into different sections of the documentation website.
For multiple sections, I took the liberty to use more recent syntax (Octane) instead of the Ember Classic one. For the rest, I kept the existing content (sometimes rephrased it a bit but nothing more).
I also removed some parts that needed to be in a Changelog and not necessarily in the documentation itself.