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

Add Godot v3.4 and v3.5 #1853

Merged
merged 2 commits into from
Nov 4, 2022

Conversation

foo-dogsquared
Copy link
Contributor

Took a stab at updating Godot docs. My Ruby-fu is weak so feel free to point out parts where it could be better.

Also pages that start with @ (e.g., @GDScript, @GlobalScope) are missing and cannot be accessed. I haven't figured that out yet.

If you're updating existing documentation to its latest version, please ensure that you have:

  • Updated the versions and releases in the scraper file
  • Ensured the license is up-to-date and that the documentation's entry in the array in about_tmpl.coffee matches its data in self.attribution
  • Ensured the icons and the SOURCE file in public/icons/your_scraper_name/ are up-to-date if the documentation has a custom icon
  • Ensured self.links contains up-to-date urls if self.links is defined
  • Tested the changes locally to ensure:
    • The scraper still works without errors
    • The scraped documentation still looks consistent with the rest of DevDocs
    • The categorization of entries is still good

Since v2 is included as one of the versions, I separated it into new
files.
@foo-dogsquared foo-dogsquared requested a review from a team as a code owner October 28, 2022 10:08
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 ed1a3ef into freeCodeCamp:main Nov 4, 2022
@foo-dogsquared foo-dogsquared deleted the update-godot-scraper branch November 5, 2022 01:15
jessevanherk added a commit to jessevanherk/devdocs that referenced this pull request Apr 22, 2024
This adds an encode method into the javascript code so that
users can browser the Godot docs for @globalscope and @GDscript.

The bug was mentioned in:
freeCodeCamp#1853

This adds the encoding on the frontend, rather than trying to override
filename generation in scrapers. It's possible that this will impact
other documentation sources, but I expect those would also need to have
encoded the @ as %40 in their own docs.

This doesn't use JS' encodeURI or encodeURIComponent because encodeURI
doesn't include @, and encodeURIComponent includes / which we don't
want. If there are other URL-reserved characters
that would be useful to encode, those should be easy enough to add to
the short method added here.
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.

None yet

2 participants