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] minimal integration READMEs #9479

Merged
merged 5 commits into from
Dec 21, 2023
Merged

[docs] minimal integration READMEs #9479

merged 5 commits into from
Dec 21, 2023

Conversation

sarah11918
Copy link
Member

Changes

This replaces all /integrations/ README.md with boilerplate, minimal text linking to the appropriate page in docs for documentation. All pages are now of the following style:

image

All integration documentation will be managed directly in the Astro Docs repo now:

https://github.com/withastro/docs/tree/main/src/content/docs/en/guides/integrations-guide/

Testing

No tests, docs change only.

Docs

All docs! Docs for all integrations/adapters will now be maintained in the docs repo.

Copy link

changeset-bot bot commented Dec 19, 2023

🦋 Changeset detected

Latest commit: 74108bb

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

@github-actions github-actions bot added pkg: svelte Related to Svelte (scope) pkg: vue Related to Vue (scope) pkg: react Related to React (scope) pkg: preact Related to Preact (scope) pkg: solid Related to Solid (scope) pkg: lit Related to Lit (scope) pkg: integration Related to any renderer integration (scope) labels Dec 19, 2023
Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

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

Looking superb!

@github-actions github-actions bot added the pr: docs A PR that includes documentation for review label Dec 19, 2023
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.

Found a small typo. The rest looks good!

packages/integrations/alpinejs/README.md Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member Author

Thank you! We will wait for @delucis to sign off with final approval!

@sarah11918
Copy link
Member Author

Assuming this is good to merge!

@sarah11918 sarah11918 merged commit 1baf0b0 into main Dec 21, 2023
2 checks passed
@sarah11918 sarah11918 deleted the integration-readmes branch December 21, 2023 20:35
@astrobot-houston astrobot-houston mentioned this pull request Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope) pkg: lit Related to Lit (scope) pkg: preact Related to Preact (scope) pkg: react Related to React (scope) pkg: solid Related to Solid (scope) pkg: svelte Related to Svelte (scope) pkg: vue Related to Vue (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants