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.

Sign up for GitHub

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

Consistency improvements to several package descriptions #6494

Merged
merged 5 commits into from
Mar 13, 2023
Merged

Consistency improvements to several package descriptions #6494

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ebdaef0
Add small improvements to package descriptions
yanthomasdev Mar 9, 2023
57a19c4
Add changeset
yanthomasdev Mar 9, 2023
26ed5e4
Merge branch 'main' into yan/more-descriptions
natemoo-re Mar 9, 2023
e7b9b8b
Merge branch 'main' into yan/more-descriptions
natemoo-re Mar 10, 2023
673e448
Merge branch 'main' into yan/more-descriptions
natemoo-re Mar 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .changeset/tiny-hairs-battle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
'@astrojs/prism': patch
'@astrojs/alpinejs': patch
'@astrojs/cloudflare': patch
'@astrojs/image': patch
'@astrojs/markdoc': patch
'@astrojs/mdx': patch
'@astrojs/partytown': patch
'@astrojs/prefetch': patch
'@astrojs/sitemap': patch
'@astrojs/markdown-component': patch
---

Consistency improvements to several package descriptions
2 changes: 1 addition & 1 deletion packages/astro-prism/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@astrojs/prism",
"version": "2.1.0",
"description": "Supports Prism highlighting in Astro projects",
"description": "Add Prism syntax highlighting support to your Astro site",
"author": "withastro",
"type": "module",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/alpinejs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/alpinejs",
"description": "The official Alpine.js integration for Astro.",
"description": "Use Alpine within Astro",
Copy link
Member

Choose a reason for hiding this comment

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

"Within" sounds a little formal here. Is there another word that's accurate enough and doesn't sound weird? "with" or "in"... 😆

Copy link
Member Author

@yanthomasdev yanthomasdev Mar 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I think "with" is fine, I used "within" just to be consistent with the other UI framework integration packages, they all follow "Use (React) components within Astro". The "components" part doesn't apply to Alpine because it's more of additional methods and properties to use in HTML. So, if we change this, I'd also feel like changing the other UI frameworks to use "with" too, what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

@Yan-Thomas I am generally happier using "with" unless you really mean to emphasize inside. The place I mostly use "within" in docs is to say that something has to be located "within" src/pages/ (meaning, anywhere inside, including a subdirectory.) I could also see using it "within a component..." or "within your template..." again, meaning inside.

So if you want to update others to say "with" I think that's great! I also think if people are searching, they're more likely to type "How do I use Alpine with Astro" (or "and Astro") not "within."

"version": "0.2.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/cloudflare/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/cloudflare",
"description": "Deploy your site to cloudflare workers or cloudflare pages",
"description": "Deploy your site to Cloudflare Workers/Pages",
"version": "6.2.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/image/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/image",
"description": "Load and transform images in your Astro site.",
"description": "Load and transform images in your Astro site",
"version": "0.16.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/markdoc/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/markdoc",
"description": "Use Markdoc within Astro",
"description": "Add support for Markdoc pages in your Astro site",
"version": "0.0.1",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/mdx/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/mdx",
"description": "Use MDX within Astro",
"description": "Add support for MDX pages in your Astro site",
"version": "0.18.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/partytown/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/partytown",
"description": "Astro + Partytown integration",
"description": "Use Partytown to move scripts into a web worker in your Astro project",
"version": "1.1.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/prefetch/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/prefetch",
"description": "Faster page navigations by prefetching links when the browser is idle.",
"description": "Prefetch page navigations in your Astro site",
"version": "0.2.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/sitemap/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@astrojs/sitemap",
"description": "Generate a sitemap for Astro",
"description": "Generate a sitemap for your Astro site",
"version": "1.2.0",
"type": "module",
"types": "./dist/index.d.ts",
Expand Down
1 change: 1 addition & 0 deletions packages/markdown/component/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@astrojs/markdown-component",
"description": "Use the legacy Markdown component in your Astro site",
"version": "1.0.2",
"type": "module",
"author": "withastro",
Expand Down