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

Documentation Enhancement #1

Open
3 of 7 tasks
ZenithClown opened this issue May 17, 2022 · 0 comments
Open
3 of 7 tasks

Documentation Enhancement #1

ZenithClown opened this issue May 17, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@ZenithClown
Copy link
Owner

ZenithClown commented May 17, 2022

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

  • Update notebooks/BOILERPLATE.ipynb with directory structure and commands. #3
  • May provide a new template file for starting a production level code.
  • Provide template for agents, engine and models for any given generic project.
  • Provide additional .github and/or CI/CD functionalities which a user can open based on requirements.
  • Setup/provide additional branches like production, development, which are required by any project.
@ZenithClown ZenithClown added the enhancement New feature or request label May 17, 2022
@ZenithClown ZenithClown self-assigned this May 17, 2022
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
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant