Update documentation to generate into API.md. #294
Conversation
It doesn't work at the moment due to an issue with emberjs/website (which also deploys via gh-pages for the whole emberjs org). For now (in order to get the docs "out there") we will add them as a markdown to the repo that is updated when releases are prepared (e.g. the same time as the changelog is generated).
README.md
Outdated
| The exact listing of events that are triggered may change over time as needed | ||
| to continue to emulate how actual browsers handle clicking a given element. | ||
|
|
||
| **Parameters** |
There was a problem hiding this comment.
On mobile this renders the same as the h4 of the functions which makes it somewhat hard to read and find stuff 🤔
There was a problem hiding this comment.
Yeah, I think that is also true on desktop.
README.md
Outdated
| * `yarn install` | ||
| - `git clone <repository-url>` this repository | ||
| - `cd ember-test-helpers` | ||
| - `yarn install` |
There was a problem hiding this comment.
IMHO it's quite annoying that documentation is reformatting the whole file when it's only supposed to replace a single section. I've had the same issue in qunit-dom and decided to have it output in a API.md instead
There was a problem hiding this comment.
Ya, agreed that its odd.
| - blur | ||
| - triggerEvent | ||
| - triggerKeyEvent | ||
| - fillIn |
There was a problem hiding this comment.
I tried this at first, but it looked strange in the HTML version. Is this still the case?
There was a problem hiding this comment.
Yes, this only works for the md version. If you do children: in the HTML formatted output its really really weird.
|
FWIW, I don't think this is a "final" solution. I just spent so much damned time on the docs, and I'd like to have something to show for it while we figure out a deployment strat for the HTML formatted output... |
|
aye, I think I'd still prefer an API.md though 🤔 |
rwjblue
force-pushed
the
interaction-helpers-root
branch
from
2bca1ad
to
44625f5
Compare
rwjblue
changed the title
Rendered README.md for easier reviewing...