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.

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

Improve documentation for v2 #1353

Merged
merged 3 commits into from
Dec 30, 2021
Merged

Improve documentation for v2 #1353

merged 3 commits into from
Dec 30, 2021

Conversation

iMacTia
Copy link
Member

@iMacTia iMacTia commented Dec 29, 2021

Description

  • Revamps the "adapters" page to prepare for the v2.0 release
  • Highlight the recommended way to use Faraday in the "usage" page
  • Explain that adapters now need to be explicitly added to the project
  • Move documentation on how to build an adapter to a dedicated page
  • Move adapters documentation to gems READMEs

* Highlight the recommended way to use Faraday in the "usage" page
* Explain that adapters now need to be explicitly added to the project
* Move documentation on how to build an adapter to a dedicated page
* Move adapters documentation to gems READMEs
@iMacTia iMacTia requested a review from olleolleolle December 29, 2021 16:10
Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

Looks ace! I noted a single place where I felt like a word was missing.

Thanks for this!

docs/adapters/write_your_adapter.md Outdated Show resolved Hide resolved
@iMacTia iMacTia merged commit 1c3e276 into main Dec 30, 2021
@iMacTia iMacTia deleted the documentation-v2-fixes branch December 30, 2021 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants