Commit Graph

27 Commits

Author SHA1 Message Date
Brian Mann b41fa610b1 docs: show alternative usage 2017-07-03 19:04:15 -04:00
Brian Mann 91bb010fd6 docs: fixes #231, cleanup all the API docs + notes
- go into more detail on trigger vs action commands
- explain actionability further
- better format notes + examples
- consistent no arg / arg examples
- es6 all the functions
- remove duplicated intractability content
- remove simulated events garbage
- go into more detail on pseudo action commands
- much better cy.contains usage
2017-06-30 18:33:52 -04:00
Brian Mann 07ed16a9d9 docs: WIP, add utility assertions, timeouts for assertions themselves 2017-06-27 23:57:05 -04:00
Brian Mann b5031f61fa docs: WIP continue writing requirements and assertions, created Rules section 2017-06-27 18:10:03 -04:00
Brian Mann 9d3a20e6aa docs: WIP refactor requirements, add assertions section, update usage content 2017-06-27 01:14:27 -04:00
Brian Mann 6acb418230 docs: WIP, normalizing all of the yields for every command
- all of the straightforward ones are done
- still working on the custom / complex ones
2017-06-25 16:22:39 -04:00
Brian Mann 669790bec2 docs: rename fields for clarity
- Notes -> Description
- Default -> Defaults
- Timeout -> Timeouts
2017-06-25 13:56:21 -04:00
Brian Mann ffa1733269 docs: fixes #210, normalize all API usage tables to be consistent 2017-06-24 19:17:41 -04:00
Brian Mann db65b0576a docs: rename helper icons for clarity, use argument 2017-06-24 15:54:35 -04:00
Brian Mann 9188da606b docs: created link helpers for API sections - yields, defaults, and timeout 2017-06-23 18:04:43 -04:00
Brian Mann f3025689fa docs: simplified / flattened image structure to better keep up with renaming / reorganizing files 2017-06-17 17:25:32 -04:00
Jennifer Shehane e1046f6bd3 docs: moved all images in API from github hosting to internal img folder 2017-06-15 19:46:01 -04:00
Jennifer Shehane d7bf77cc1f docs: Updated external urls to url tags + converted image tags to markdown 2017-06-13 19:30:37 -04:00
Jennifer Shehane 1dfe741a3e docs: replace other erroneous links 2017-06-13 18:51:51 -04:00
Loren Norman f947e0c55d Merge remote-tracking branch 'origin/master'
# Conflicts:
#	docs/source/guides/getting-started/installing-cypress.md
2017-06-13 15:49:54 -04:00
Jennifer Shehane 1cc47441ec docs: Lots of api links converted to url tags
- Sadly, had to pull out half of the changelog due to a Max call stack
being reached when entire changelog with all url tags are built. :(
2017-06-12 15:56:37 -04:00
Jennifer Shehane be23695f40 More url conversions 2017-06-09 14:31:02 -04:00
Jennifer Shehane 70e7c04763 Began converting existing links to url tags 2017-06-09 14:04:20 -04:00
Jennifer Shehane 175fbc1e8d docs: fix 'description' in head / fix api page titles
- removed description from each api file since default is better
- fixed camelcase in api page titles
2017-06-07 12:30:40 -04:00
Jennifer Shehane 0392d96d7c docs: cleaning up more api 2017-06-01 14:18:22 -04:00
Jennifer Shehane cbec33d637 Converted 'its' - 'pause'
- Updated some existing api docs to reflect structure changes
- Added missing ‘pause’ command to sidebar and .yml english.
2017-05-26 14:31:41 -04:00
Jennifer Mann de8d3c6f14 docs: Change 'Related' section to 'See also' 2017-05-23 17:17:27 -04:00
Jennifer Mann 59f778ebae docs: Update uses of double quotes in JS code examples to single quotes 2017-05-23 17:13:27 -04:00
Jennifer Mann 5f73a975b0 Remove #section- from all all inter-page links 2017-05-19 12:01:36 -04:00
Jennifer Mann d82a6473ba Update front matter of api docs to have description and top divider 2017-05-19 11:59:55 -04:00
Jennifer Mann 66a445cb17 removed hr's from api markdown files 2017-05-19 11:51:03 -04:00
Chris Breiding 43f24d950c import docs/ (CYP-907-hexo) 2017-05-15 14:10:01 -04:00