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

FR: add canonical site, icon, and aliases to docs.json #2210

Open
chrisgrieser opened this issue May 3, 2024 · 0 comments
Open

FR: add canonical site, icon, and aliases to docs.json #2210

chrisgrieser opened this issue May 3, 2024 · 0 comments
Labels

Comments

@chrisgrieser
Copy link

Feature request

Add some more information to the docs.json, such as the original site, link to the (fav)icon, and aliases.

Summary

The docs.json is very useful to query devdocs for which sites are available, and I am using it for a plugin I wrote for Alfred. Adding some more information such as aliases or icons would make the json even more useful.

Examples

  {
    "name": "Python",
    "slug": "python~3.12",
    "alias": "py",
    "type": "python",
    "links": {
      "home": "https://www.python.org/",
      "code": "https://github.com/python/cpython",
      "canonical": "https://devdocs.io/python~3.12/reference/%s"
    },
   "icon": "https://raw.githubusercontent.com/freeCodeCamp/devdocs/main/public/icons/docs/python/16%402x.png",
    "version": "3.12",
    "release": "3.12.1",
    "mtime": 1704473584,
    "db_size": 17684105,
    "attribution": "&copy; 2001&ndash;2023 Python Software Foundation<br>\n      Licensed under the PSF License."
  },
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant