Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Readme clean up #250

Merged
merged 1 commit into from Aug 5, 2020
Merged

Readme clean up #250

merged 1 commit into from Aug 5, 2020

Conversation

camilamaia
Copy link
Member

Readme clean up. Move documentation from README.md to the website

Closes #227

@camilamaia camilamaia requested review from a team as code owners August 5, 2020 14:00
@camilamaia camilamaia self-assigned this Aug 5, 2020
@github-actions
Copy link

github-actions bot commented Aug 5, 2020

@camilamaia your pull request is missing a changelog!

@camilamaia camilamaia requested a review from a team August 5, 2020 14:02
@abreumatheus
Copy link
Member

@camilamaia I think maybe you should leave the documentation section in the file and in the table of contents, just for the ease of access. Otherwise, the user will not know where to find the link to the documentation until he scrolls all the way down.
Ex:

# Documentation
The full documentation is available at [scanapi.dev](https://scanapi.dev)!

abreumatheus
abreumatheus reviewed Aug 5, 2020
View reviewed changes
README.md Outdated
```

Available attributes to hide: `headers`, `body` and `url`.
The full documentation is available at [scanapi.dev][https://scanapi.dev]!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hyperlink should be enclosed in parenthesis here :)
Ex:
The full documentation is available at [scanapi.dev](https://scanapi.dev)!

@camilamaia
Copy link
Member Author

@camilamaia I think maybe you should leave the documentation section in the file and in the table of contents, just for the ease of access. Otherwise, the user will not know where to find the link to the documentation until he scrolls all the way down.
Ex:

# Documentation
The full documentation is available at [scanapi.dev](https://scanapi.dev)!

great idea! I am going to do the same for examples. Thanks!

@camilamaia
Copy link
Member Author

@abreumatheus done! ✅

@camilamaia camilamaia merged commit 97c4451 into master Aug 5, 2020
@camilamaia camilamaia deleted the clean-readme branch August 5, 2020 14:57
@camilamaia camilamaia mentioned this pull request Aug 25, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abreumatheus abreumatheus abreumatheus approved these changes

Assignees

@camilamaia camilamaia

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move documentation from README.md to the website
2 participants
@camilamaia @abreumatheus