Skip to content

Add Odin documentation#2687

Open
jask06 wants to merge 4 commits into
freeCodeCamp:mainfrom
jask06:main
Open

Add Odin documentation#2687
jask06 wants to merge 4 commits into
freeCodeCamp:mainfrom
jask06:main

Conversation

@jask06

@jask06 jask06 commented May 26, 2026

Copy link
Copy Markdown

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

NOTE: No 16@2x.png image was available from the Odin repo, so I used https://convertico.com/favicon-resizer/ to upscale the available 16x16 image.

This should also satisfy #2632

Please let me know your thoughts!

@jask06 jask06 requested a review from a team as a code owner May 26, 2026 04:15
@jask06

jask06 commented Jun 9, 2026

Copy link
Copy Markdown
Author

Please let me know if there are any issues with the current PR!

Comment thread lib/docs/scrapers/odin.rb
Comment on lines +32 to +35
options[:attribution] = <<-HTML
&copy; 2016-#{Date.today.year} Ginger Bill<br>
Licensed under the 3-clause BSD License.
HTML

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 license has been changed, see odin-lang/Odin@842cfee.

Comment on lines +3 to +5
self.name = 'Odin Packages'
self.slug = 'odin_packages'
self.type = 'odin_packages'

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.

I would prefer to have this separate scraper to be merged with the main odin. Using one without the other does not seem overly helpful to me. Also, this follows practice we've been following for other scrapers (such as crystal or rust).

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