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.

Sign up for GitHub

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

Jump to bottom

Write README #4

Closed
35 tasks done
blahosyl opened this issue Apr 7, 2024 · 0 comments
Closed
35 tasks done

Write README #4

blahosyl opened this issue Apr 7, 2024 · 0 comments
Assignees
@blahosyl
Labels
documentation Improvements or additions to documentation ongoing Tasks performed throughout development

Comments

@blahosyl
Copy link
Owner

blahosyl commented Apr 7, 2024 •
edited
Loading

README sections:

  • Intro
  • User Experience
    • User goals
    • Creator goals
  • Design
    • Flowchart
    • Flow description
    • Code design
    • CRUD functionalities
    • Database
    • User interaction/Terminal design
  • Features
  • Technologies used
    • Languages used
    • Python Frameworks & libraries used
    • Tools used
    • Development process
  • Deployment
  • Testing
    • Automated testing
    • Manual testing
      • User story testing
      • Feature testing
      • Input validation testing
      • Flow testing
    • Accessibility testing
  • Credits

Add-ons:

  • Shield.io badges
  • Social picture for repo
  • Description for repo

At the end:

  • Spell check
  • Link check
  • Image check
  • Add TOC
  • copy+paste check ("publishing", "operator")
@blahosyl blahosyl added documentation Improvements or additions to documentation ongoing Tasks performed throughout development labels Apr 7, 2024
@blahosyl blahosyl self-assigned this Apr 7, 2024
blahosyl added a commit that referenced this issue Apr 9, 2024
@blahosyl
add deployment steps and address #10 #4
77c40be
blahosyl added a commit that referenced this issue Apr 9, 2024
@blahosyl
track and show available dishes #14 #4
3d070a5
blahosyl added a commit that referenced this issue Apr 9, 2024
@blahosyl
add credit to README #4
473af97
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
remove template text from README #4
5f583ae
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
add study material credits to README #4
94ce972
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
add flowchart to README #4 #14 #2
9cfd4f7
blahosyl added a commit that referenced this issue Apr 11, 2024
@blahosyl
add study credits and GSheet link to README #4
8130e01
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
add CRUD breakdown #4
4b0443d
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
add testing scenarios #4
0eb00d2
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
add test cases #4
87f41a5
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
add test cases #4
b61a6e4
blahosyl added a commit that referenced this issue Apr 13, 2024
@blahosyl
begin "Technologies used" section #4
fb7a09e
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
add study credits to README #4 #30
b2bd754
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
add credits to README #4
1df3717
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
document naming conventions #4 #30
a4c3bfe
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
update Flow in README #4
ef7a9b0
blahosyl added a commit that referenced this issue Apr 14, 2024
@blahosyl
add code credits #4 #8
889d710
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
add stud credits #4
67bbe08
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
add repo forking steps #4
6379494
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
fix capitalisation + update text in study credits #4
f2c17f2
@blahosyl blahosyl moved this from Todo to Ongoing/Blocked in Dinner Party Planner Apr 15, 2024
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
Style heading + font #4 #21
9b0ad47
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
add and style logo #4 #21
928297c
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
add SEO meta tags #21 #4
6f8f25b
blahosyl added a commit that referenced this issue Apr 15, 2024
@blahosyl
update Design section #4
16be575
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
update database descr, add tool link #4
aea2204
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add feature screen descriptions #4
5186336
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add feature screen descriptions #4
a8fe779
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
update image descriptions and spell check #4
f7e3d56
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add Code design section #4
275c033
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct & update Code design section #4
e6a85dd
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
update Code design sec #4
93c3642
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct README.md #4
4e432b3
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add user goal testing writeup #4
9cdd9da
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct UX section #4
84b6fc4
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct heading #4
b05a1c4
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add creator goal testing #4
6769376
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
ad brosers & devices #4
fa0edff
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add credit #4
03ff9a5
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct link #4
7d2d6a8
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct link #4
45ff7c0
@blahosyl blahosyl moved this from Ongoing/Blocked to In Progress in Dinner Party Planner Apr 20, 2024
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
correct link #4
a52ffbe
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
update README.md #4
3e3a632
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
update README.md #4
8473c22
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add tools #4
a3a65b8
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
fix link #4
747dc64
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
fix capitalization #4
987e9c5
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add credit #4
12dd0b8
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
spell check README.md #4
8904fb9
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
spell check README.md #4
427a2a5
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add TOC to README.md #4
228c044
blahosyl added a commit that referenced this issue Apr 20, 2024
@blahosyl
add TOC to TESTING.md #4
b9ceadf
@github-project-automation github-project-automation bot moved this from In Progress to Done in Dinner Party Planner Apr 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blahosyl blahosyl

Labels
documentation Improvements or additions to documentation ongoing Tasks performed throughout development
Projects
Dinner Party Planner
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blahosyl