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

Create docs folder/sub-folders with a corresponding table of contents #45

Open
2 tasks
zacgra opened this issue Oct 27, 2022 · 0 comments
Open
2 tasks

Comments

@zacgra
Copy link
Contributor

zacgra commented Oct 27, 2022

Need to add a documentation folder to the project with a table of contents.

  • create folders and sub-folders
  • add table of contents

Contents to include the following:

  • Getting Started - project setup, where to get environment variables
  • Git Procedures - git flow, commit message examples, pull request comment examples for single and multi-commit PRs
  • Sprint Lead - how to do it, what is expected
  • Team-to-Team Interfaces - define data models and what data one teams needs from another team, apis required
  • Team Docs - any diagrams or descriptions that might be helpful for other teams to understand your team's role and solution
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

No branches or pull requests

1 participant