mirror of
https://github.com/freeCodeCamp/devdocs
synced 2024-11-16 19:48:10 +01:00
1.9 KiB
1.9 KiB
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 doc16@2x.png: a 32×32 pixel icon for the docSOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself
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.coffeematches its data inself.attribution - Ensured the icons and the
SOURCEfile inpublic/icons/your_scraper_name/are up-to-date if the documentation has a custom icon - Ensured
self.linkscontains up-to-date urls ifself.linksis 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