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

Docs: update content and various tweaks to the markdown #465

Merged
merged 1 commit into from
Apr 16, 2021

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Mar 21, 2021

The "Documentation" section of the https://requests.ryanmccue.info/ website is automatically generated from the files in the docs folder.

The last time the site was generated was in 2016. Since then a lot has changed in GH Pages and a lot of the dependencies used to generate a site have been updated to newer releases.

This commit makes various tweaks to the markdown for improved rendering on the current GH Pages setup.
While going through the pages, I've also done a cursory review of the content and fixed up information which was extremely outdated or plain incorrect by now.

Includes:

  • Use spaces not tabs for indentation in markdown files.
  • Fixing up various URLs/links.
  • Removal of various uses of ableist language.
  • Punctuation fixes.

@jrfnl jrfnl added this to the 1.8.0 milestone Mar 21, 2021
@jrfnl jrfnl requested a review from schlessera March 21, 2021 08:51
@codecov
Copy link

codecov bot commented Mar 21, 2021

Codecov Report

Merging #465 (697d7dc) into master (60926fa) will increase coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #465      +/-   ##
============================================
+ Coverage     92.89%   92.95%   +0.05%     
  Complexity      764      764              
============================================
  Files            21       21              
  Lines          1788     1788              
============================================
+ Hits           1661     1662       +1     
+ Misses          127      126       -1     
Impacted Files Coverage Δ Complexity Δ
library/Requests/Transport/fsockopen.php 93.78% <0.00%> (-0.57%) 69.00% <0.00%> (ø%)
library/Requests/Proxy/HTTP.php 100.00% <0.00%> (+6.66%) 13.00% <0.00%> (ø%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 60926fa...697d7dc. Read the comment docs.

@jrfnl jrfnl force-pushed the feature/fix-up-docs-for-ghpages branch from 6281515 to 3355715 Compare March 21, 2021 09:19
@jrfnl jrfnl mentioned this pull request Mar 22, 2021
3 tasks
The "Documentation" section of the https://requests.ryanmccue.info/ website is automatically generated from the files in the `docs` folder.

The last time the site was generated was in 2016. Since then a lot has changed in GH Pages and a lot of the [dependencies](https://pages.github.com/versions/) used to generate a site have been updated to newer releases.

This commit makes various tweaks to the markdown for improved rendering on the current GH Pages setup.
While going through the pages, I've also done a cursory review of the content and fixed up information which was extremely outdated or plain incorrect by now.

Includes:
* Use spaces not tabs for indentation in markdown files.
* Fixing up various URLs/links.
* Removal of various uses of ableist language.
* Punctuation fixes.
@jrfnl jrfnl force-pushed the feature/fix-up-docs-for-ghpages branch from 3355715 to 697d7dc Compare March 22, 2021 08:39
@jrfnl
Copy link
Member Author

jrfnl commented Mar 22, 2021

Rebased for merge conflict

@schlessera schlessera merged commit 5fdcc83 into master Apr 16, 2021
@schlessera schlessera deleted the feature/fix-up-docs-for-ghpages branch April 16, 2021 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants