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

feat(documentation): Add documentation support for three.js #2392

Merged
merged 14 commits into from
Feb 23, 2025

Conversation

chaitanyarahalkar
Copy link
Contributor

@chaitanyarahalkar chaitanyarahalkar commented Dec 24, 2024

  • 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/threejs/ 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

Addressed issue #2351

This PR adds documentation support for three.js. The parsers for this were slightly complicated since three.js uses a different mechanism to render its documentation. The FileScraper based approach is used where the documentation is first downloaded and then the parser is applied on the locally downloaded files.

Sorry, something went wrong.

@chaitanyarahalkar chaitanyarahalkar requested a review from a team as a code owner December 24, 2024 05:13
@chaitanyarahalkar chaitanyarahalkar changed the title Add documentation support for three.js feat(documentation): Add documentation support for three.js Dec 25, 2024
@chaitanyarahalkar
Copy link
Contributor Author

Hey @ojeytonwilliams @simon04! Let me know your thoughts on the PR.

Thank you!

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.

Great, thank you!

@simon04 simon04 merged commit 1c07f17 into freeCodeCamp:main Feb 23, 2025
2 checks passed
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.

None yet

2 participants