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

Add README.md files for the plugins. #2474

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

jieguangzhou
Copy link
Collaborator

Description

Related Issues

Checklist

  • Is this code covered by new or existing unit tests or integration tests?
  • Did you run make unit_testing and make integration-testing successfully?
  • Do new classes, functions, methods and parameters all have docstrings?
  • Were existing docstrings updated, if necessary?
  • Was external documentation updated, if necessary?

Additional Notes or Comments

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

A script used to generate a README.md.

The README.md contains two parts:

  1. Metadata and class messages updated by the script.
  2. Custom documentation sections that will not be updated by the script.

@jieguangzhou jieguangzhou force-pushed the doc/plugin_and_template branch 9 times, most recently from e5b55d5 to 2e7f51b Compare September 26, 2024 08:29
@jieguangzhou jieguangzhou marked this pull request as ready for review September 26, 2024 08:35
@jieguangzhou jieguangzhou force-pushed the doc/plugin_and_template branch from 2e7f51b to 9dd1d9e Compare September 26, 2024 08:58
@jieguangzhou jieguangzhou merged commit 9851801 into superduper-io:main Sep 26, 2024
17 checks passed
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 this pull request may close these issues.

[RESTRUCTURE] Restructure documentation to reflect separation of concerns: package vs. application
2 participants