[ ] Does this have sufficient context for the specific functionality being developed (design, business rules, etc.)
User Story
As a user visiting the CAMPD homepage
I want to see a card for the API docs with a brief description and link to the docs
So that I can to go straight to the docs from the homepage
Acceptance Criteria
Given an API subpage (or placeholder page if it doesn't exist yet)
When a user visits the homepage
Then they should see a large card with a title of API Docs, a brief description, and a link to the docs
Given an API docs card on the homepage
When a user clicks on the card or a link on the card
Then they should be redirected to the API docs subpage
Given an API docs card on the homepage
When a user resizes their screen or visits the page on their phone
Then this card should adjust to the screen size and wrap with the other components on the page
Development Notes
See the invision wireframe for reference
Testing
Test Description
Verify this card links to the API docs when clicked. Verify the card resizes and wraps on mobile or smaller screen sizes.
Assumptions and Pre-Conditions
Assume an API docs subpage exists or a placeholder page for testing
Test Data
A mock page to link to
Steps to be Executed
Open the homepage
Click on the API docs card and verify it takes you to the API docs subpage
Go back to the homepage
Resize the page and verify the card stays within the screen and wraps if necessary
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 CAMPD homepage I want to see a card for the API docs with a brief description and link to the docs So that I can to go straight to the docs from the homepage
Acceptance Criteria
Given an API subpage (or placeholder page if it doesn't exist yet) When a user visits the homepage Then they should see a large card with a title of API Docs, a brief description, and a link to the docs
Given an API docs card on the homepage When a user clicks on the card or a link on the card Then they should be redirected to the API docs subpage
Given an API docs card on the homepage When a user resizes their screen or visits the page on their phone Then this card should adjust to the screen size and wrap with the other components on the page
Development Notes
See the invision wireframe for reference
Testing
Test Description
Verify this card links to the API docs when clicked. Verify the card resizes and wraps on mobile or smaller screen sizes.
Assumptions and Pre-Conditions
Assume an API docs subpage exists or a placeholder page for testing
Test Data
A mock page to link to
Steps to be Executed
Definition of Done