Skip to content

Add ReactiveX documentation - #970

Merged
jmerle merged 8 commits into
freeCodeCamp:masterfrom
jmerle:reactivex
Oct 20, 2019
Merged

jmerle merged 8 commits into
freeCodeCamp:masterfrom
jmerle:reactivex

Conversation

@jmerle

@jmerle jmerle commented Jan 26, 2019

Copy link
Copy Markdown
Contributor

Added a scraper for the ReactiveX documentation.

The documentation is licensed under the Apache License 2.0.

The official icon is also licensed under the Apache License 2.0. Because I could only find a 32x32 version with a transparent background in the ReactiveX repositories, I used Imagick's convert to create a 16x16 version of it.

Image downloading is disabled because the docs contain a lot of images which makes scraping really, really slow (10+ seconds for some pages), and because enabling it causes 14 pages to be skipped because of an HTTP error. Not sure why that is, but when options[:download_images] is set to false, it works fine.

Types:

@j-f1

j-f1 commented Aug 23, 2019

Copy link
Copy Markdown
Contributor

Looks like you’ve got a merge conflict on Prism.js.

@jmerle

jmerle commented Aug 23, 2019

Copy link
Copy Markdown
Contributor Author

Fixed :)

@jmerle
jmerle requested a review from j-f1 August 23, 2019 20:44

@j-f1 j-f1 left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • The Backpressure topic only has one article, and the title is lowercase. Could you fix this and maybe move it to another topic? It also seems like the accordion headers don’t retain the code formatting on that page.

css('h2').each do |node|
node.inner_html = node.inner_html.gsub('Information:', 'Information')
end

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

On http://localhost:9292/reactivex/documentation/operators#categorized, the linked code blocks don’t show up properly. This is because the HTML structure is like <a><strong><code>...</code></strong></a>, so the <code> element doesn’t know it’s supposed to inherit its color. This could be fixed either by stripping out the extra <strong>, moving it outside of the <a>, or changing the base DevDocs CSS to match a <code> anywhere inside a <a>. Here’s the offending rule:

a > code { color: inherit; }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looking at this again, the <strong> seems to have some significance in this doc, so going the route of changing the above selector would be better, so as to retain the boldface. However, it seems there’s an additional rule specifying font-weight: normal for code spans, so that needs to be either overridden or removed (if it’s not necessary).

@jmerle

jmerle commented Aug 28, 2019

Copy link
Copy Markdown
Contributor Author

Processed your review comments. Regarding the Backpressure Operators page, it is now properly capitalized and categorized under "Manual".

@j-f1 j-f1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just the one comment I unresolved, but everything else LGTM.

@j-f1 j-f1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oops, one more thing:

Co-Authored-By: Jed Fox <git@twopointzero.us>
@jmerle
jmerle requested a review from j-f1 October 10, 2019 02:09
@jmerle jmerle mentioned this pull request Oct 10, 2019
jmerle added a commit to jmerle/devdocs that referenced this pull request Oct 20, 2019
@jmerle
jmerle merged commit 5e09a49 into freeCodeCamp:master Oct 20, 2019
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