docs: update README and split into different files #899
Conversation
docs/cli.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "CLI" section.
docs/commands.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Commands API" section.
docs/config.md
Outdated
There was a problem hiding this comment.
This file is mostly unchanged, it was moved from the README ".hermione.conf.js" section.
The only change here is moving events to a separate page.
docs/dealing-with-browsers.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Prerequisites" section.
docs/events.md
Outdated
There was a problem hiding this comment.
This file is based on events section, which was previously located in README .hermione.conf.js section. It is mostly unchanged, I've just added headings.
docs/features.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Why hermione?" section.
docs/programmatic-api.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Programmatic API" section.
docs/quick-start.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Quick start" section.
docs/typescript.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Typescript" section.
docs/writing-tests.md
Outdated
There was a problem hiding this comment.
This file hasn't been changed at all, it was just moved from the README "Test API" section.
There was a problem hiding this comment.
This file has been written from scratch.
Note:
- There will be svg logo at the top center part of the page,
docs/images/testplane.svg, it's not showing up till the PR is merged - Links to other pages won't work till the PR is merged
- I think the most convenient way to review this file is open a preview of it
- Since links to other pages are absolute, they still contain "hermione" as a name of the repo. We will need to edit them once again after renaming the repo.
|
TODO: try changing absolute links to images, md files to relative. If not possible, change master branch to re-branding |
|
I force-pushed to my branch. There are no changes that intersect with your commit (https://github.com/gemini-testing/hermione/compare/d3f3776b63dacd72428dbc354a24a7afebbb2a1e..a23643b9c8090e5ac9a7756094b5240ec4f96e97), but you still need to rebase (or you could just pull cc @shadowusr |
shadowusr
force-pushed
the
users/shadowusr/HERMIONE-1470
branch
from
d339e0b
to
340336d
Compare
* docs: update README and split it into different files
* docs: update README and split it into different files
* docs: update README and split it into different files
What's done