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

Added Documentation for React-bootstrap #1486

Merged
merged 7 commits into from
Feb 26, 2021

Conversation

dohsimpson
Copy link
Contributor

If you’re adding a new scraper, please ensure that you have:

  • Tested the scraper on a local copy of DevDocs
  • Ensured that the docs are styled similarly to other docs on DevDocs
  • Added these files to the public/icons/your_scraper_name/ directory:
    • 16.png: a 16×16 pixel icon for the doc
    • 16@2x.png: a 32×32 pixel icon for the doc
    • SOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself

@dohsimpson dohsimpson requested a review from a team as a code owner February 20, 2021 16:54
Copy link
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

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

Thank you. Please see my review comments.

lib/docs/filters/react_bootstrap/entries.rb Outdated Show resolved Hide resolved
@@ -0,0 +1,17 @@
module Docs
class ReactBootstrap
class CleanHtmlFilter < Filter
Copy link
Contributor

Choose a reason for hiding this comment

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

Please clean as much from the original HTML as possible:

  • Unwrap ._page _simple (in particular to make some CSS selectors of DevDocs effective).
  • A non exhaustive list of classes that should be removed: ___gatsby, gatsby-focus-wrapper, flex-xl-nowrap row, Heading-styles-module--heading--3cEKx __heading, ReactPlayground-StyledContainer-module--cls2--3Uz4N ReactPlayground-StyledContainer-module--cls1--1Jg9m -- As a rule of thumb, we try to remove every class which is not strictly necessary to minimize the docs size.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @simon04 , thanks for the review, I have fixed the second bullet point, which is to remove most of the unnecessary classes. But I would like to keep the styling as "simple" please. As the default "simple" stylesheet looks pretty good in my opinion.

lib/docs/filters/react_bootstrap/clean_html.rb Outdated Show resolved Hide resolved
lib/docs/scrapers/react_bootstrap.rb Show resolved Hide resolved
Copy link
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

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

Thank you!

@simon04 simon04 merged commit 7480257 into freeCodeCamp:master Feb 26, 2021
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