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

More integration README fixes #3885

Merged
merged 8 commits into from
Jul 11, 2022
Merged

More integration README fixes #3885

merged 8 commits into from
Jul 11, 2022

Conversation

delucis
Copy link
Member

@delucis delucis commented Jul 10, 2022

Changes

More tweaks to README formatting to accompany withastro/docs#954

Key things:

  • Update the homepage field in package.json to point to the new docs pages!
  • Add standard content for troubleshooting & changelog sections of READMEs
  • Remove empty Examples sections from READMEs
  • Don’t use <br> as they look out of place in the styled context of the docs
  • Use code backticks for filenames
  • Make sure code blocks all have a language (sh, js, etc.)

Testing

n/a

Docs

All docs, all the time ✨

@changeset-bot
Copy link

changeset-bot bot commented Jul 10, 2022

🦋 Changeset detected

Latest commit: 9bc7548

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

This PR includes changesets to release 22 packages
Name Type
@astrojs/cloudflare Patch
@astrojs/deno Patch
@astrojs/image Patch
@astrojs/mdx Patch
@astrojs/netlify Patch
@astrojs/node Patch
@astrojs/partytown Patch
@astrojs/preact Patch
@astrojs/prefetch Patch
@astrojs/react Patch
@astrojs/sitemap Patch
@astrojs/solid-js Patch
@astrojs/svelte Patch
@astrojs/tailwind Patch
@astrojs/vercel Patch
@astrojs/vue Patch
@e2e/preact-component Patch
@e2e/react-component Patch
@e2e/solid-component Patch
@e2e/svelte-component Patch
@e2e/ts-resolution Patch
@e2e/e2e-tailwindcss 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

@github-actions github-actions bot added 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) pkg: integration Related to any renderer integration (scope) labels Jul 10, 2022
@github-actions github-actions bot added the pkg: lit Related to Lit (scope) label Jul 11, 2022
@sarah11918
Copy link
Member

It all LGTM, @delucis !

Copy link
Contributor

@tony-sull tony-sull left a comment

Choose a reason for hiding this comment

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

This looks great! Very excited to see these pages right on the docs site! Looks good to me once the docs pages are merged in 🚀

Added one tiny note related to keeping the use of sh vs shell consistent, feel free to ignore as they should be aliases in the markdown parser anyway 😄

packages/integrations/lit/README.md Show resolved Hide resolved
@delucis delucis merged commit bf5d1cc into main Jul 11, 2022
@delucis delucis deleted the delucis/integration-readmes branch July 11, 2022 19:10
@astrobot-houston astrobot-houston mentioned this pull request Jul 11, 2022
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)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants