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

Improved rss readme #12157

Merged
merged 10 commits into from
Oct 15, 2024
Merged

Improved rss readme #12157

merged 10 commits into from
Oct 15, 2024

Conversation

bholmesdev
Copy link
Contributor

Changes

This tightens up the RSS README to remove unneeded guide pages (consistent with integration readmes) and reduce complexity of config options.

  • Remove the guide section and reference our docs entry
  • Inline the RSSFeedItem docs under items
  • Remove a duplicate docs section for content
  • Update types to show field types instead of object
  • Add support and contributing sections based on other integration READMEs

Testing

N/A

Docs

Follow up from this discussion on the RSS docs.

Follow ups

We should remove the inline documentation for item options 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.

Copy link

changeset-bot bot commented Oct 8, 2024

🦋 Changeset detected

Latest 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 <[email protected]>
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Show resolved Hide resolved
packages/astro-rss/README.md Outdated Show resolved Hide resolved
packages/astro-rss/README.md Show resolved Hide resolved
packages/astro-rss/README.md Outdated Show resolved Hide resolved
packages/astro-rss/README.md Show resolved Hide resolved
packages/astro-rss/README.md Show resolved Hide resolved
packages/astro-rss/README.md Outdated Show resolved Hide resolved
packages/astro-rss/README.md Outdated Show resolved Hide resolved
## `rssSchema`
Type: `Record<string, string> (optional)`

An object mapping a set of `xmlns` suffixes to strings of metadata on the opening `<rss>` tag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So two things here:

  1. A second sentence like "This is used to/for" with plain language explanation of the purpose here would be nice.

  2. If the URL is just an example, then standard practice is to use example.com EVERYWHERE, even when other URLs seem fun.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This took me down a rabbithole to understand what xmlns even is. Learned a lot! Updated the entry to give a practical example

packages/astro-rss/README.md Outdated Show resolved Hide resolved
Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I leave the final OK to Sarah :) once she gives the gree light, we can merge it

bholmesdev and others added 5 commits October 10, 2024 08:16
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
@sarah11918
Copy link
Member

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! 🫡

@bholmesdev bholmesdev merged commit 925cff3 into main Oct 15, 2024
2 checks passed
@bholmesdev bholmesdev deleted the feat/improved-rss-readme branch October 15, 2024 15:13
@astrobot-houston astrobot-houston mentioned this pull request Oct 15, 2024
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.

4 participants