docs icon indicating copy to clipboard operation
docs copied to clipboard

Integration Page missing Link to Prism Docs

Open Artur-Galstyan opened this issue 2 years ago • 5 comments

On this website: https://astro.build/integrations/official/

the integration box for Prism just links back to the main page instead of linking to this (for example):

https://docs.astro.build/en/reference/api-reference/#prism-

Artur-Galstyan avatar Oct 13 '22 05:10 Artur-Galstyan

Can I pick this up please @Artur-Galstyan ?

ShaswatPrabhat avatar Oct 13 '22 12:10 ShaswatPrabhat

Of course 😊

Artur-Galstyan avatar Oct 13 '22 12:10 Artur-Galstyan

This would mostly mean a change in the url in package.json for the astro/prism package:

https://github.com/withastro/astro/blob/main/packages/astro-prism/package.json

Shall I rather open a PR against this package in the astro repo ?

ShaswatPrabhat avatar Oct 13 '22 12:10 ShaswatPrabhat

@ShaswatPrabhat I can tell you that the problem with this is that we don't have a Docs page for the Prism package and integrations are linking to their corresponding "Guide" page in the Docs (which is pulled from the integration README in withastro/astro). In fact, Prism is not technically an "integration" at all, in the same way that our RSS package is a package is not an "integration."

I think it should probably be treated the same way our RSS package is, and not even listed as an integration on astro.build in the first place. RSS is not, and RSS is an example of a package that must be separately installed vs an integration with an astro add command.

I'll ask @tony-sull to weigh in on this one! It's not a Docs issue, but it's something for classifying the Prism package behind the scenes, or deciding what exactly it is and where it should be listed. Keeping this open for now until Tony replies, so that I also know what's happening, and whether we make a decision that means we do have to account for a Guide page in Docs.

sarah11918 avatar Oct 13 '22 13:10 sarah11918

Thank you for the detailed explanation @sarah11918 !

ShaswatPrabhat avatar Oct 13 '22 13:10 ShaswatPrabhat

This was fixed! Thanks again for bringing it to our attention!

sarah11918 avatar Dec 29 '22 12:12 sarah11918