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

Crystal docs: Use fully qualified name for entries #2404

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

Conversation

spuun
Copy link
Contributor

@spuun spuun commented Jan 17, 2025

Currently entities name for Crystal is just the short version making it impossible to distinguish search hits:
image

This PR will change entry name to be the fully qualified name:
image

It also enables searches like "json builder", which isn't possible today.

--

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

@spuun spuun requested a review from a team as a code owner January 17, 2025 10:17
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.

1 participant