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

Docs: remaining integration READMEs #2885

Merged
merged 7 commits into from
Mar 25, 2022

Conversation

bholmesdev
Copy link
Contributor

@bholmesdev bholmesdev commented Mar 25, 2022

Changes

  • Add remaining integration READMEs
    • @astrojs/partytown
    • @astrojs/tailwind
    • @astrojs/turbolinks
    • @astrojs/sitemap

Testing

Docs

@changeset-bot
Copy link

changeset-bot bot commented Mar 25, 2022

🦋 Changeset detected

Latest commit: 428f32f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 10 packages
Name Type
@astrojs/partytown Patch
@astrojs/sitemap Patch
@astrojs/tailwind Patch
@astrojs/turbolinks Patch
@astrojs/lit Patch
@astrojs/preact Patch
@astrojs/react Patch
@astrojs/solid-js Patch
@astrojs/svelte Patch
@astrojs/vue Patch

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

Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

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

These all look great!

Not blocking, but I'd consider moving the Getting Started sections above Installation? For someone unfamiliar with what these tools do, they probably want a description of the tool before deciding to install it.

packages/integrations/partytown/README.md Outdated Show resolved Hide resolved
@bholmesdev
Copy link
Contributor Author

Not blocking, but I'd consider moving the Getting Started sections above Installation? For someone unfamiliar with what these tools do, they probably want a description of the tool before deciding to install it.

@natemoo-re So fair point, but I'm not sure the getting started calls-to-action make sense at the beginning? For instance, asking users to "try navigating between different pages via links" for Turbo won't work until the installation step. I think the one-liners at the top of the README are sufficient to understand what the tool does 🤷

Ex.

This Astro integration brings Turbo to your Astro project.

@bholmesdev bholmesdev merged commit 6b00436 into main Mar 25, 2022
@bholmesdev bholmesdev deleted the docs/readmes-remaining-integrations branch March 25, 2022 21:45
@github-actions github-actions bot mentioned this pull request Mar 25, 2022
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.

2 participants