summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jake Strawn <himerus@users.noreply.github.com> 2022-09-26 10:14:34 -0400
committerGravatar GitHub <noreply@github.com> 2022-09-26 16:14:34 +0200
commit5fc73ba02c183d23da6ad6f3c4ac938754b28bad (patch)
tree7297189abceefa66c80181536f47147abf9c8e27
parentb0f62163674176b9fa444dee3a02b390d22d8be4 (diff)
downloadastro-5fc73ba02c183d23da6ad6f3c4ac938754b28bad.tar.gz
astro-5fc73ba02c183d23da6ad6f3c4ac938754b28bad.tar.zst
astro-5fc73ba02c183d23da6ad6f3c4ac938754b28bad.zip
docs: Standardize common integration READMEs (#4874)
-rw-r--r--packages/integrations/cloudflare/README.md12
-rw-r--r--packages/integrations/lit/README.md10
-rw-r--r--packages/integrations/react/README.md10
-rw-r--r--packages/integrations/solid/README.md10
-rw-r--r--packages/integrations/svelte/README.md10
-rw-r--r--packages/integrations/turbolinks/README.md10
-rw-r--r--packages/integrations/vue/README.md10
7 files changed, 66 insertions, 6 deletions
diff --git a/packages/integrations/cloudflare/README.md b/packages/integrations/cloudflare/README.md
index 0f5609d5c..80d7808ae 100644
--- a/packages/integrations/cloudflare/README.md
+++ b/packages/integrations/cloudflare/README.md
@@ -90,3 +90,15 @@ export default {
},
}
```
+
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
+
+[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
diff --git a/packages/integrations/lit/README.md b/packages/integrations/lit/README.md
index 23bda5cf9..f1cfd3787 100644
--- a/packages/integrations/lit/README.md
+++ b/packages/integrations/lit/README.md
@@ -111,9 +111,15 @@ import {MyElement} from '../components/my-element.js';
The above will only load the element's JavaScript when the user has scrolled it into view. Since it is server rendered they will not see any jank; it will load and hydrate transparently.
-### More documentation
+## Troubleshooting
-Check our [Astro Integration Documentation][astro-integration] for more on integrations.
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
diff --git a/packages/integrations/react/README.md b/packages/integrations/react/README.md
index eac25522d..721d62283 100644
--- a/packages/integrations/react/README.md
+++ b/packages/integrations/react/README.md
@@ -59,7 +59,15 @@ To use your first React component in Astro, head to our [UI framework documentat
- 💧 client-side hydration options, and
- 🤝 opportunities to mix and nest frameworks together
-Also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
diff --git a/packages/integrations/solid/README.md b/packages/integrations/solid/README.md
index 3cb9e69e4..89579fb4a 100644
--- a/packages/integrations/solid/README.md
+++ b/packages/integrations/solid/README.md
@@ -59,7 +59,15 @@ To use your first SolidJS component in Astro, head to our [UI framework document
- 💧 client-side hydration options, and
- 🤝 opportunities to mix and nest frameworks together
-Also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
diff --git a/packages/integrations/svelte/README.md b/packages/integrations/svelte/README.md
index 1554560a3..ab6f5d856 100644
--- a/packages/integrations/svelte/README.md
+++ b/packages/integrations/svelte/README.md
@@ -59,7 +59,15 @@ To use your first Svelte component in Astro, head to our [UI framework documenta
- 💧 client-side hydration options, and
- 🤝 opportunities to mix and nest frameworks together
-Also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
diff --git a/packages/integrations/turbolinks/README.md b/packages/integrations/turbolinks/README.md
index 569015d85..ed974010d 100644
--- a/packages/integrations/turbolinks/README.md
+++ b/packages/integrations/turbolinks/README.md
@@ -62,5 +62,15 @@ Turbo links, frames, and more should be ready-to-use with zero config. For insta
Head to [the Turbo handbook](https://turbo.hotwired.dev/handbook/introduction) for all options and features available. You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
+
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
diff --git a/packages/integrations/vue/README.md b/packages/integrations/vue/README.md
index 85f5ef98a..2a1f94c6f 100644
--- a/packages/integrations/vue/README.md
+++ b/packages/integrations/vue/README.md
@@ -59,7 +59,15 @@ To use your first Vue component in Astro, head to our [UI framework documentatio
- 💧 client-side hydration options, and
- 🤝 opportunities to mix and nest frameworks together
-Also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components