[ ] Does this have sufficient context for the specific functionality being developed (design, business rules, etc.)
User Story
As a user visiting the API docs
I want to see a grid of cards that describe each API and link to them
So that I can quickly click on the card and navigate to the docs
Acceptance Criteria
Given a list of placeholder text (title and description) for now
When a user visits the API docs page
Then they should see a set of cards with placeholder text in a grid underneath the overview text at the top
Given a card in the grid
When the card is displayed
Then it should have a title, description, and "View docs" button
Given a grid of cards
When the page is resized
Then the cards should wrap to new rows accordingly
Development Notes
See the invision wireframe for reference. This is a simple user story without the actual API info. Another issue will be created to add the actual info.
Testing
Test Description
Verify the cards display on the page appropriately and wrap when resized.
Assumptions and Pre-Conditions
Assume a set of info about APIs
Test Data
Placeholder information
Steps to be Executed
Supply a list of placeholder API info
Visit the API docs page
Verify the cards render in a grid and adjust according to mobile and desktop sizes
Definition of Done
[ ] Have all Acceptance Criteria been agreed to and validated by the scrum team?
[ ] Has the code been unit tested and peer reviewed?
[ ] Have the functional tests been executed?
[ ] Have all defects been reviewed and dispositioned, resolved, or deferred?
[ ] Is the user story ready to be deployed to the test/staging environments?
Definition of Ready
User Story
As a user visiting the API docs I want to see a grid of cards that describe each API and link to them So that I can quickly click on the card and navigate to the docs
Acceptance Criteria
Given a list of placeholder text (title and description) for now When a user visits the API docs page Then they should see a set of cards with placeholder text in a grid underneath the overview text at the top
Given a card in the grid When the card is displayed Then it should have a title, description, and "View docs" button
Given a grid of cards When the page is resized Then the cards should wrap to new rows accordingly
Development Notes
See the invision wireframe for reference. This is a simple user story without the actual API info. Another issue will be created to add the actual info.
Testing
Test Description
Verify the cards display on the page appropriately and wrap when resized.
Assumptions and Pre-Conditions
Assume a set of info about APIs
Test Data
Placeholder information
Steps to be Executed
Definition of Done