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

Automatically include integration READMEs on docs site #945

Closed
2 of 3 tasks
delucis opened this issue Jul 7, 2022 · 0 comments · Fixed by #954
Closed
2 of 3 tasks

Automatically include integration READMEs on docs site #945

delucis opened this issue Jul 7, 2022 · 0 comments · Fixed by #954
Assignees

Comments

@delucis
Copy link
Member

delucis commented Jul 7, 2022

Random Reminders

  • Include link to relevant starter package/astro.new?? (For playing around, seeing what it should look like if it works, minimal reproductions if trouble)

Notes from Chris’s sync w/ Tony, 7/7/22

  • Add integration READMEs to Docs — only official @astrojs ones for now
  • Show links using a deploy-style icon grid in the Integrations Guide
  • Link to new pages from the cards on https://astro.build/integrations/ (maybe straight update the URLs in each integration’s package.json so we also link to docs from npm?)
  • Follow same pattern as for Configuration Reference:
    • fetch READMEs in a nightly CI task
    • generate .md pages from those
    • open a PR with any changes
    • That will trigger the i18n process like any other page and gives us a chance to label the PR as typo/minor etc. if we need to
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 a pull request may close this issue.

2 participants