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

Improvement documentation for plug-ins #777

Merged
merged 7 commits into from
Nov 17, 2024
Merged

Improvement documentation for plug-ins #777

merged 7 commits into from
Nov 17, 2024

Conversation

paulrobertlloyd
Copy link
Collaborator

  • Show plug-in README.md files on documentation site
  • Move plug-in API to top level
  • Use npm install … for plug-in installation (a little bit friendlier)
  • Update installation and usage instructions for pre-installed plug-ins
  • Consistently show requirements for plug-ins that need API secrets, keys or tokens
  • Other various content tweaks

This means that essential documentation can be seen (and searched) from the main documentation site, consolidating this information in one place.

Fixes #766. Replaces #767.

@paulrobertlloyd paulrobertlloyd added the documentation Good documentation benefits everyone label Nov 17, 2024
@paulrobertlloyd paulrobertlloyd merged commit 716ab71 into main Nov 17, 2024
1 check failed
@paulrobertlloyd paulrobertlloyd deleted the docs/plug-ins branch November 17, 2024 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Good documentation benefits everyone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Token permissions required to use GitHub content store are not included in the docs
1 participant