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

Update documentation #50

Open
2 of 3 tasks
renan-souza opened this issue Feb 10, 2023 · 2 comments
Open
2 of 3 tasks

Update documentation #50

renan-souza opened this issue Feb 10, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation priority:medium

Comments

@renan-souza
Copy link
Collaborator

renan-souza commented Feb 10, 2023

  • README
  • Contributing
  • Add docstrings to the APIs and BaseInterceptors
@renan-souza renan-souza added documentation Improvements or additions to documentation priority:medium labels Feb 10, 2023
@renan-souza
Copy link
Collaborator Author

The CONTRIBUTING needs to be updated as we did some major changes (e.g., no more black/flake) and the Checklist needs to be tested. https://github.com/ORNL/flowcept/blob/main/CONTRIBUTING.md#checklist-for-creating-a-new-flowcept-adapter

Also, we can add sessions on how to extend the MQ and Database.

@wigging
Copy link
Collaborator

wigging commented Nov 7, 2024

I updated the contributing guidelines in the sphinx documentation pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:medium
Projects
None yet
Development

No branches or pull requests

2 participants