Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore(docs): add link to badges #2603

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(docs): add link to badges #2603

wants to merge 1 commit into from

Conversation

@Olexandr88
Copy link

@Olexandr88 Olexandr88 commented Oct 16, 2025

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
    • [email protected]: 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

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

@Olexandr88 Olexandr88 requested a review from a team as a code owner October 16, 2025 12:21
simon04
simon04 requested changes Oct 19, 2025
View reviewed changes
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.

Hm, do you think it's worth the effort? That is, yannickglt/alfred-devdocs has to be specified 6 times (now: 4 times). If you think so, I'm happy to merge. However, all other plugins would need to be updated as well.

@Olexandr88
Copy link
Author

Olexandr88 commented Oct 19, 2025

Yes, I understand it's a bit of a painstaking process, but I'm ready to tackle it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@simon04 simon04 simon04 requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Olexandr88 @simon04