Project Wiki and Design Docs

[siascone]

Wiki Home Page

• [x] Is the first page you see upon entering the wiki
• [x] Contains a welcome message
• [x] Contains a link/placeholder for a link to the live page
• [x] All links in the right sidebar should contain each wiki page and link to the correct page
• [x] Correctly formatted
  • [x] each wiki page is listed in bullet points
  • [x] all links route the correct page

---

MVP List

• [x] Should have 7 MVPs.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [x] The other 4 are from the Approved Apps List or your PM will have clarified them with you
• [x] Contains a description sentence of the app
• [x] Includes two to three detailed bullets on functionality and presentation of feature
• [x] At least one CRUD feature, which states what CRUD operations are planned (creation, reading, updating, deletion)
• [x] Estimates how long it will take the code each MVP
• [x] Correctly formatted
  • [x] MVPs are listed in an ordered list
  • [x] Each MVP is broken down into bullet points

---

Database Schema

• [x] Contains correct datatypes
• [x] Contains appropriate constraints/details
  • [x] primary key
  • [x] not null
  • [x] unique
  • [x] indexed
  • [x] foreign key
• [x] Contains bullet points after the table that state which foreign keys will reference to which table, or references to the associations which will be made
  • [x] foreign key and table name are lowercased, snake_cased and back_ticked
• [x] Correctly formatted
  • [x] schema is written in a table format
  • [x] the table’s name are lowercased, snake_cased and back_ticked
  • [x] the table header column names are bolded
  • [x] columns names are lowercased and snaked_cased and back_ticked

---

Sample State

• [x] State shape is flat!
• [x] State’s keys are camelCased
• [x] All keys within the values in the state are accessible in the schema
• [x] Correctly formatted
  • [x] Sample state is rendered with triple backticks, and the language ```javascript...```). This will display the state as a code block instead of a giant line of text
  • [x] Top level slices
  • [x] entities
  • [x] session
  • [x] errors (here or in ui)
  • [x] ui (if needed)
  • [x] Should NOT have nested slices, aka comments inside of posts
  • Some info from other tables is ok, for instance:
  • the author username and imageurl for a post. basically any info that the user can’t change
  • like count and a boolean on whether the user likes the post instead of a likes slice

---

Backend Routes

• [x] Contains the following sections: HTML, API Endpoints(Backend)
• [x] Each route has a description
• [x] API Endpoint routes contains wildcard variables written in snake_case
• [x] Routes does not contain superfluous routes
• [x] Have API routes that will allow the front end to get all info it needs and does not have unneeded routes:
  • probably doesn’t need a GET likes api endpoint because that info comes through the post show

---

Frontend Routes

• [x] Frontend routes contains wildcard variables written in camelCase
• [x] Correctly formatted
  • [x] Routes are displayed with inline coding text (backticks)

[siascone]

Notes - For all notes please reference the BlueBird Wiki

Good start so far. Please review the notes below and make the recommended adjustments.

Wiki Home Page:

• Update "Stack Exchange Clone" to " Design Documents"
• Add a live link place holder to above your document page list

MVP List:

• The featuers should be a numbered list 1-7
• Missing Hosting, User Auth and Production README (please review the bludebird wiki for reference)
• Need to list two to three details bullets for each feature
• Missing dates and time estimates for features (ex: Questions (2.5 days 2/3/23 - 2/6/23))
• Let me know if you have any questions about writing markdown to get bullets, numbers, headings etc to display on the page.

Database Schema:

• add backticks to column names
• add backticks to table names
• add detail bullets for each table regarding indexing and has_many/belongs_to relationships
  • make sure referenced column names and properties are backticked
• missing Answers table
• missing Votes joins table

[siascone]

Notes:

Wiki Home Page:

• Missing live link and welcome sentence
• Frontend Routes link does not link to a frontend route page. I assume this is coming soon

Features List:

• Looking good
• Missing description sentence of app
• Profiles feature will be a bonus feature and does not need to be included in your Features list at this time

Schema:

• Complete

Sample State:

• I like the example data. Good bit of humor.
• keys must be camelCased not snake_cased
• Missing the following top level keys; ui:, errors:, and session:

Backend Routes

• make sure to have routes listed as bullets for each relation
• users: you won't need a GET /api/users at this time as you won't be searching for users (could add this down the road)
• questions: need the following routes GET /api/questions for retrieving all questions, GET /api/questions/:id for retrieving a single question, POST /api/questions for creating a question, PATCH /api/questions/:id for updating a question, DELETE /api/questions/:id for deleting a question
• answers should have the same set of routes as questions just at /api/answers
• votes should have routes for POST /api/votes and DELETE /api/votes for creating and deleting a vote. When implementing you may want to have the posting of a vote accept an additional property for up/down, this could be a boolean in your database
• session. right routes, just needs descriptions of what those routes do.

Frontend Routes

• missing

[siascone]

Notes:

Your docs look great. I would add one more component to your frontend routes.

On your QuestionShow you will need to house an AnswerIndex

Great work!