New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs #995
Update docs #995
Conversation
Codecov Report
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I absolutely ❤️ it! Thank you so much! I have nothing to request except for one thing, see my suggestions below.
@alina-beck you have a new follower on Github. I will also add you to the team "Volunteers", so that will give you write permissions into our repositories. Write permissions means, you can push branches and you can also merge into master (after approving code review).
@@ -16,7 +16,7 @@ The following features will be implemented. This gets done in three steps: | |||
|
|||
### User Account | |||
|
|||
[Cucumber Features](./integration/user_account) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_account) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_account) | |
[Cucumber Features](./integration/user_account) |
In this case it would be better to keep the relative path. Why? If you send in a PR and let's say you changed the referenced file and if a code reviewer would click on the link, she would be redirected to the master
branch. You can try it out yourself by clicking on "Preview" and then click on the link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, that's not ideal. The reason I changed it is that the relative paths are not working on GitBook. For some reason they add a /README.md
to the end of the link and since there are no README
s in the cypress/integrations
folder you land on a 404 page...
Any idea how to get this working for both use cases?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No! In that case I'll approve this and merge. 👍
@@ -34,7 +34,7 @@ The following features will be implemented. This gets done in three steps: | |||
|
|||
### User Profile | |||
|
|||
[Cucumber Features](./integration/user_profile) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_profile) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_profile) | |
[Cucumber Features](./integration/user_profile) |
@@ -59,7 +59,7 @@ The following features will be implemented. This gets done in three steps: | |||
|
|||
### Posts | |||
|
|||
[Cucumber Features](./integration/post/) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/post) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/post) | |
[Cucumber Features](./cypress/integration/post) |
* Deleting Comments | ||
* Editing Comments | ||
* Upvote comments of others | ||
|
||
### Notifications | ||
[Cucumber features](./integration/notifications) | ||
[Cucumber features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/notifications) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/notifications) | |
[Cucumber features](./cypress/integration/notifications) |
@@ -116,7 +116,7 @@ The following features will be implemented. This gets done in three steps: | |||
|
|||
### Search | |||
|
|||
[Cucumber Features](./integration/search) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/search) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/search) | |
[Cucumber Features](./cypress/integration/search) |
@@ -237,7 +237,7 @@ Shows automatically related actions for existing post. | |||
|
|||
### Moderation | |||
|
|||
[Cucumber Features](./integration/moderation) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/moderation) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/moderation) | |
[Cucumber Features](./cypress/integration/moderation) |
@@ -262,7 +262,7 @@ Shows automatically related actions for existing post. | |||
|
|||
### Internationalization | |||
|
|||
[Cucumber Features](./integration/internationalization) | |||
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/internationalization) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/internationalization) | |
[Cucumber Features](./cypress/integration/internationalization) |
🍰 Pull request
Issues
Todo