Conversation
🦋 Changeset detectedLatest commit: 46c1bf9 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
sarah11918
left a comment
There was a problem hiding this comment.
Hey @bholmesdev this is fantastic! (And, makes me really want to see this as a proper integration 😅 )
Left some stray thoughts below! 🙌
packages/astro-rss/README.md
Outdated
| ## `rssSchema` | ||
| Type: `Record<string, string> (optional)` | ||
|
|
||
| An object mapping a set of `xmlns` suffixes to strings of metadata on the opening `<rss>` tag. |
There was a problem hiding this comment.
So two things here:
-
A second sentence like "This is used to/for" with plain language explanation of the purpose here would be nice.
-
If the URL is just an example, then standard practice is to use
example.comEVERYWHERE, even when other URLs seem fun.
There was a problem hiding this comment.
This took me down a rabbithole to understand what xmlns even is. Learned a lot! Updated the entry to give a practical example
ematipico
left a comment
There was a problem hiding this comment.
I leave the final OK to Sarah :) once she gives the gree light, we can merge it
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
|
Thanks @bholmesdev ! Left some follow up and I think you should have all the feedback you need from me to make your final judgement calls, and merge at will! 🫡 |
Changes
This tightens up the RSS README to remove unneeded guide pages (consistent with integration readmes) and reduce complexity of config options.
RSSFeedItemdocs underitemscontentobjectTesting
N/A
Docs
Follow up from this discussion on the RSS docs.
Follow ups
We should remove the inline documentation for
itemoptions and link to this README as a single source of truth. This should prevent out-of-date options. We should also clearly link to this README to learn more about config options.