-
-
Notifications
You must be signed in to change notification settings - Fork 4
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
Documentation Enhancement #1
Labels
enhancement
New feature or request
Comments
ZenithClown
added a commit
that referenced
this issue
Nov 30, 2022
CONTRIBUTING.md is available under `.github` directory, and is referenced, thus no need to update at directory level as mentioned in #1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Overview
The project is missing some crucial documentation, which needs to be updated. Since I'm currently working alone on this project, it might require some extra time to update all the necessary things fully. I've listed the important documentation first for the initial level, followed by others (which may be updated on a later release).
Important Documentation
Code Related Documentation
notebooks/BOILERPLATE.ipynb
with directory structure and commands. #3agents
,engine
andmodels
for any given generic project..github
and/or CI/CD functionalities which a user can open based on requirements.production
,development
, which are required by any project.The text was updated successfully, but these errors were encountered: