Delete this section completely - these are just resources to help you with creating your documentation.

GitHub Docs - Writing and Formating on Github: https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/basic-writing-and-formatting-syntax

Github Guids - Mastering Markdown: https://guides.github.com/features/mastering-markdown/

Include a paragraph describing the project. Some things you should write about in your description are:

• A breif description of the Stakeholder Company and their goals overall.
• A breif description of the company's goals with this project.
• What is the problem(s) your team is trying to solve/answer.
• The final(or planned) solution to the problem(s)

Add the final product video for either web or ds (depending on what the repo is for) here.

Include a list of all the contributors and links to their GitHubs and LinkedIn Profiles.

Here is an example of how you could do it:

• Fork and clone to get the code for the table below
• Paste it twice to add more teammates and make sure to include a blank line in between the two
• Be sure to update ALL github and linkedin links with your team's info or it will link to me and my friends
• You can get each person's picture by clicking on their GitHub profile picture and copying the url in the browser
• The people in the photos below are some of my favorite people from lambda school... You should follow them

May Ng	Tommy Colemon	Nisa Champagne	Jason Long
Team Project Lead	Web Developer	Web Developer	Data Scientist

• Include ALL links to deployed end products (BE, FE, & DS)
• Make sure they are clearly labeled

• Include ALL links to connecting repos
• Describe how they are connected
• Make sure they are clearly labeled

• Describe what was inherited as a team

• Include links to legacy documentation & repos

• Include a link to the Product Vision Document

• Include a second paragraph decribing how the next team can get started working with this repo

• Describe where and how each portion is deployed

• What needs to be changed in order to deploy to a new environment (do not add an secrets here)

• List the tech stack used
• Described what it was used for

• Write out a description of your user flow
• Include a screen shots of the user flow

• Front End should include a description and screen shot of wireframes

• Write out a description of the architecture diagram

• Include a screen shot of the archtecture diagram

• Describe the file hierarchy and where to find things (BE, FE, or DS specific)

• Describe what you have changed in this repo as a team
• Provide examples and descriptions of components, how props are handled, where to find these changes, database tables, models, etc.

• Provide a list of End Points and what they are used for (Don't just link to your API, actually write out a description for each one so it's clear for the next team)
• Include a link to your API documentation if you have them (I use postman to create visually appealing API Docs)

• Include current issues/bugs that could not be fixed before Thursday of week 4
• Format it as a task list for legibility

• Describe what you wanted to do but could not get to
• List any other ideas you had for the app or apis
• Include links to any other research you have done for this project

Who to contact for further support. Include at least two names. They can use the contributors list above to get in contact with you, or find you on slack.