User Story:
AS A DEVELOPER
I want to access Wiki Developer Documentation on our Github Repo for Fitness Rivals app
so that I can understand the codebase and contribute effectively.
Acceptance Criteria:
SCENARIO: Accessing Wiki Documentation
GIVEN I am a developer working on Fitness Rivals app
WHEN I navigate to the Github repository
AND I locate the Wiki section
THEN I should be able to view comprehensive developer documentation
AND it should cover the architecture, code structure, and guidelines for contribution
SCENARIO: Searching for Specific Information
GIVEN I am a developer looking for specific information in the documentation
WHEN I use the search functionality within the Wiki
AND I enter relevant keywords
THEN I should receive accurate and relevant search results
AND it should help me quickly find the information I need
Tasks:
Create Wiki pages covering architecture, code structure, contribution guidelines, and any other necessary developer documentation.
Organize the Wiki pages in a clear and intuitive manner for easy navigation.
Implement a search functionality within the Wiki using Github's search capabilities.
Test the search functionality to ensure accurate and relevant results.
Review and update the documentation regularly to keep it up-to-date with the codebase changes.
○ A full-stack diagram showing interactions among front end(s), backend
(including at least authentication and database, and cloud functions (if
any)), and any external web APIs that the app uses;
○ The database schema;
○ Screenshots of app screens and their supporting blocks. Complex blocks
are to have their own screenshot and subsection explaining them in
detail.
○ Subsections on each cloud function showing its code and explaining it.
○ Whatever else a developer would need to contribute to your app.
User Story: AS A DEVELOPER I want to access Wiki Developer Documentation on our Github Repo for Fitness Rivals app so that I can understand the codebase and contribute effectively.
Acceptance Criteria: SCENARIO: Accessing Wiki Documentation GIVEN I am a developer working on Fitness Rivals app WHEN I navigate to the Github repository AND I locate the Wiki section THEN I should be able to view comprehensive developer documentation AND it should cover the architecture, code structure, and guidelines for contribution
SCENARIO: Searching for Specific Information GIVEN I am a developer looking for specific information in the documentation WHEN I use the search functionality within the Wiki AND I enter relevant keywords THEN I should receive accurate and relevant search results AND it should help me quickly find the information I need
Tasks:
Create Wiki pages covering architecture, code structure, contribution guidelines, and any other necessary developer documentation. Organize the Wiki pages in a clear and intuitive manner for easy navigation. Implement a search functionality within the Wiki using Github's search capabilities. Test the search functionality to ensure accurate and relevant results. Review and update the documentation regularly to keep it up-to-date with the codebase changes.
○ A full-stack diagram showing interactions among front end(s), backend (including at least authentication and database, and cloud functions (if any)), and any external web APIs that the app uses; ○ The database schema; ○ Screenshots of app screens and their supporting blocks. Complex blocks are to have their own screenshot and subsection explaining them in detail. ○ Subsections on each cloud function showing its code and explaining it. ○ Whatever else a developer would need to contribute to your app.