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.

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

Create MKDocs #55

Closed
himanshusharma89 opened this issue Mar 6, 2021 · 10 comments
Closed

Create MKDocs #55

himanshusharma89 opened this issue Mar 6, 2021 · 10 comments
Labels
documentation Improvements or additions to documentation GSSOC21 Issues created for GSSOC'21 Level1 easy gssoc issue Level2 medium gssoc issue

Comments

@himanshusharma89
Copy link
Owner

himanshusharma89 commented Mar 6, 2021

Use MK DOcs to create documentation of the app, you can refer to https://smaranjitghose.github.io/img_ai_app_boilerplate/getting_started/

We will assign this issue one page at a time. The list of pages will be updated soon.

@himanshusharma89 himanshusharma89 changed the title Create Docs Create MKDocs Mar 6, 2021
@github-actions github-actions bot added documentation Improvements or additions to documentation GSSOC21 Issues created for GSSOC'21 labels Mar 6, 2021
@himanshusharma89 himanshusharma89 added Level1 easy gssoc issue Level2 medium gssoc issue labels Mar 6, 2021
@Chirag018
Copy link
Contributor

Can I work on this ?

@smaranjitghose
Copy link
Collaborator

Use MK DOcs to create documentation of the app, you can refer to https://smaranjitghose.github.io/img_ai_app_boilerplate/getting_started/

We will assign this issue one page at a time. The list of pages will be updated soon.

Try to use the material theme with dark mode and keep the documentation related code in a separate branch

@Chirag018
Copy link
Contributor

Use MK DOcs to create documentation of the app, you can refer to https://smaranjitghose.github.io/img_ai_app_boilerplate/getting_started/
We will assign this issue one page at a time. The list of pages will be updated soon.

Try to use the material theme with dark mode and keep the documentation related code in a separate branch

For the entire app should I document or just one page.

@himanshusharma89
Copy link
Owner Author

@Chirag018 Create only the home page for now.

@Rishabh510
Copy link
Collaborator

@Chirag018 Are you working on it? Its been 3 days.

@himanshusharma89
Copy link
Owner Author

@Chirag018 Are you working on it? Its been 3 days.

Yeah, let us know if you are facing any issue

@Chirag018
Copy link
Contributor

Sir @Rishabh510 , @himanshusharma89 I will update you by today.

@Rishabh510
Copy link
Collaborator

@himanshusharma89 I think we can assign the issue to someone else.

@himanshusharma89
Copy link
Owner Author

@Chirag018 Any update?

@Chirag018
Copy link
Contributor

@himanshusharma89 sir you can assign this task to someone else

@SapinderSingh SapinderSingh mentioned this issue Apr 18, 2021
5 tasks
himanshusharma89 added a commit that referenced this issue Apr 18, 2021
* Home updated

* files rearranged

* Search screen

* Cart Improvements

* Product screen fix

* Increase/Decrease Product Quantity

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* logo

* Update README.md

* Update README.md

* Update README.md

* Added Hack 20 logo

* Update README.md

* Update README.md

* Update README.md

* :feat Added Logos and GIFs

* Update README.md

* New Products

* Update README.md

* Update README.md

* New Products

* Update README.md

* Update README.md

* Update README.md

* Revert "Update README.md"

This reverts commit 0ec4a94.

* Added Promo Logo

* Update README.md

* Update README.md

* Added GIFS

* Update README.md

* Update README.md

* Update README.md

* Removed Damaged Gifs

* Update README.md

* Delete logo.png

* Create LICENSE

* Create CODE_OF_CONDUCT.md

* Update README.md

* Update .gitignore

* :feat mockups

* Update README.md

* overflow fix

* Add CONTRIBUTING.md

* Update README.md

* add labeler action for hacktoberfest

* Added delete branch on close PR workflow

* Added SvanBoxel's Implementation for deleting merged branch

* Added android release workflow

* Update android-release.yml

* File renamed

* naming convention update

* Update GITIGNORE

* naming convention update

* Assets Update

* Folder Structure Update

* Update README.md

* Update issue_label.yml

* fixed an issue of overflow using expanded and textoverflow

* Update android-release.yml

* Added Firebase Integration

* feat: razorpay

* gitignore update

* Scroll Physics Update

* Razorpay Test Key and Secret Added

* Flutter SVG dependecy issue fixed

* App Drawer Added

* Update issue_label.yml

* ListTiles added to the App Drawer

* Update issue_label.yml

* Added License, Code of Conduct and Contributing guidelines to README

* Initialize Firebase in app

* reoved web support

* feat: added linting using lint package

* style: fixed linter suggested warnings and errors

* Updated Contributing guidelines in README

* renderflex overflow fixed

* Added steps for cloning the app on contributer's environment

* added welcome bot

* removed leading search icon on home screen Search Bar

* Implemented a better way to hide the keyboard properly

* Update issue_label.yml

* docs: added issue templates

* removing unwanted commits

* Create pull_request_template.md

* docs: added pr label workflow

* docs: updated event name

* added product model

* made profile screen responsive for small screen size

* Added Named Routes and removed redundant code

* Added menu icon to the top right to navigate to the "Settings" screen

Updated profile screen by adding menu icon to the top right . This issue #39 was assigned to me and now is resolved.

* making requested changes

for #39

* made changes 

made separate settings.dart and added widget

* Outsourced Drawer and Drawer Item widgets

* added widget tests for ProductCard, ProductPage and BottomNavigationBar

* added widget tests for CartItem, OrderItem

* Added Named routes.

* Update issue_label.yml

* fixes #105

* Removed scroll glow

* refactor: changed package name

Changed package name from com.example.retro_shopping to tech.himanshusharma.relicbazaar.

Fixes #84

* refactor: changed package name

Changed package name from com.example.retro_shopping to tech.himanshusharma.relicbazaar.

Fixes #84

* Made Settings layout

* Package Name Update

* home screen updated

* Issue-118

* Added Order model

* Created Order model

* 'Wishlist-Screen'

* Created about page

* Fixed the Renderflex Overflow issue

* Order Screen

* AdMob integration

* Gradle Version Upgrade

* fix: Issue 101

* issue #38 made manage address screen

* made changes to manage address

* Issues Resolved

* android, ios native splash screens added

* added ads on dashboard and product page

* Code Refactoring

* added code for faqs screen

* Added login screen(With all resolved changes)

* Update README.md

* Resolved all the changes

* made the changes

* Added google signin

* Added SignUp Screen

* Update CONTRIBUTING.md

Added linting rule statement

* Update pull_request_template.md

Added extra point to check for linting rules before merging

* fix: bump flutter version in the app release action

* Added the change username and password screen

* Project Structure Update

* Stacked Container Added

* Fixed Issue #151

* back to shop button on cart screen made to work.

* Added batches on top in Readme.md file

* Made the changes Issue #151

* Batches aligned at center

* resolved all the warnings

* Added T&C Screen Issue #38

* Added Email Auth #27

* Added Unknown Screen. Fixes Issue #161

* removed unknown route constant

* Firebase Remote Config

* Initialized remote config main

* Overflow problem in Settings Page

* Overflow problem in Settings Page

* Expanded the list view.
prevented the payment button to hide behind the ad banner in cart view.

* README.md file enhanced (#107)

* README.md enhanced

* README.md enhanced

* README.md enhanced

* README.md enhanced

* readme updated

* readme updated

* readme updated

* Login UI Update (#170)

* Added horizontal scroll to login page

* Resized widgets in login page

* Added space between text boxes in login page

Co-authored-by: AksV73 <[email protected]>

* Added in app web view for github repository link (#172)

* Code Cleanup

* Used FocusNode to shift from one TextFormField to another (#179)

* Made Logout button functional in Settings screen. Fixes #38 (#176)

* Made Logout Button Functional. Fixes #38

* Added all the features as instructed. Fixes #38

* Code Cleanup + UI Update

* Keep User Logged In (#181)

onAuthStateChanges Stream Added

* Fixes Issue #183. Added Privacy Policy Screen.

* added notificationsScreen (#184)

* made the new changes and squashed

* made changes

* fixed renderflex error

* Auth Update

* Fixes #190

* Deleted all the files.

* Fixes Issue #55

Co-authored-by: Himanshu Sharma <[email protected]>
Co-authored-by: Smaranjit Ghose <[email protected]>
Co-authored-by: Anush Bhatia <[email protected]>
Co-authored-by: Ishan Sharma <[email protected]>
Co-authored-by: Anush Bhatia <[email protected]>
Co-authored-by: HIMANSHU SHARMA <[email protected]>
Co-authored-by: Vipul Sinha <[email protected]>
Co-authored-by: lordvins226 <[email protected]>
Co-authored-by: Tushar-OP <[email protected]>
Co-authored-by: ecrax <[email protected]>
Co-authored-by: Ajay <[email protected]>
Co-authored-by: Mansi169 <[email protected]>
Co-authored-by: “nb9960” <“[email protected]”>
Co-authored-by: Diksha Goyal <[email protected]>
Co-authored-by: Saransh <[email protected]>
Co-authored-by: Alifbhanvadiya14 <[email protected]>
Co-authored-by: Aayush Bisen <[email protected]>
Co-authored-by: Mohit <[email protected]>
Co-authored-by: sloth-panda <[email protected]>
Co-authored-by: Rahul Gandhi <[email protected]>
Co-authored-by: abhishek7997 <[email protected]>
Co-authored-by: Praneeth-rdy <[email protected]>
Co-authored-by: Pawan <[email protected]>
Co-authored-by: Sakshi Gupta <[email protected]>
Co-authored-by: D <[email protected]>
Co-authored-by: piyushpradhan <[email protected]>
Co-authored-by: Chirag <[email protected]>
Co-authored-by: Abhi-1313 <[email protected]>
Co-authored-by: Suyash Choudhary <[email protected]>
Co-authored-by: ThatOneTallKid <[email protected]>
Co-authored-by: Neha Musale <[email protected]>
Co-authored-by: Rupanshi Chawda <[email protected]>
Co-authored-by: Suyash Choudhary <[email protected]>
Co-authored-by: Apurv <[email protected]>
Co-authored-by: AJAYK-01 <[email protected]>
Co-authored-by: Aman Nanda <[email protected]>
Co-authored-by: samdid <[email protected]>
Co-authored-by: ADITI YADAV <[email protected]>
Co-authored-by: Rishabh Raizada <[email protected]>
Co-authored-by: DOOMSTERR <[email protected]>
Co-authored-by: Puru Ganda <[email protected]>
Co-authored-by: Mus2413 <[email protected]>
Co-authored-by: Anirudh Sai S B <[email protected]>
Co-authored-by: AksV73 <[email protected]>
Co-authored-by: AksV73 <[email protected]>
Co-authored-by: ShrutiJ-01 <[email protected]>
Co-authored-by: Sumit Didhate <[email protected]>
Co-authored-by: Muskan Jain <[email protected]>
himanshusharma89 added a commit that referenced this issue Apr 18, 2021
* files rearranged

* Search screen

* Cart Improvements

* Product screen fix

* Increase/Decrease Product Quantity

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* logo

* Update README.md

* Update README.md

* Update README.md

* Added Hack 20 logo

* Update README.md

* Update README.md

* Update README.md

* :feat Added Logos and GIFs

* Update README.md

* New Products

* Update README.md

* Update README.md

* New Products

* Update README.md

* Update README.md

* Update README.md

* Revert "Update README.md"

This reverts commit 0ec4a94.

* Added Promo Logo

* Update README.md

* Update README.md

* Added GIFS

* Update README.md

* Update README.md

* Update README.md

* Removed Damaged Gifs

* Update README.md

* Delete logo.png

* Create LICENSE

* Create CODE_OF_CONDUCT.md

* Update README.md

* Update .gitignore

* :feat mockups

* Update README.md

* overflow fix

* Add CONTRIBUTING.md

* Update README.md

* add labeler action for hacktoberfest

* Added delete branch on close PR workflow

* Added SvanBoxel's Implementation for deleting merged branch

* Added android release workflow

* Update android-release.yml

* File renamed

* naming convention update

* Update GITIGNORE

* naming convention update

* Assets Update

* Folder Structure Update

* Update README.md

* Update issue_label.yml

* fixed an issue of overflow using expanded and textoverflow

* Update android-release.yml

* Added Firebase Integration

* feat: razorpay

* gitignore update

* Scroll Physics Update

* Razorpay Test Key and Secret Added

* Flutter SVG dependecy issue fixed

* App Drawer Added

* Update issue_label.yml

* ListTiles added to the App Drawer

* Update issue_label.yml

* Added License, Code of Conduct and Contributing guidelines to README

* Initialize Firebase in app

* reoved web support

* feat: added linting using lint package

* style: fixed linter suggested warnings and errors

* Updated Contributing guidelines in README

* renderflex overflow fixed

* Added steps for cloning the app on contributer's environment

* added welcome bot

* removed leading search icon on home screen Search Bar

* Implemented a better way to hide the keyboard properly

* Update issue_label.yml

* docs: added issue templates

* removing unwanted commits

* Create pull_request_template.md

* docs: added pr label workflow

* docs: updated event name

* added product model

* made profile screen responsive for small screen size

* Added Named Routes and removed redundant code

* Added menu icon to the top right to navigate to the "Settings" screen

Updated profile screen by adding menu icon to the top right . This issue #39 was assigned to me and now is resolved.

* making requested changes

for #39

* made changes 

made separate settings.dart and added widget

* Outsourced Drawer and Drawer Item widgets

* added widget tests for ProductCard, ProductPage and BottomNavigationBar

* added widget tests for CartItem, OrderItem

* Added Named routes.

* Update issue_label.yml

* fixes #105

* Removed scroll glow

* refactor: changed package name

Changed package name from com.example.retro_shopping to tech.himanshusharma.relicbazaar.

Fixes #84

* refactor: changed package name

Changed package name from com.example.retro_shopping to tech.himanshusharma.relicbazaar.

Fixes #84

* Made Settings layout

* Package Name Update

* home screen updated

* Issue-118

* Added Order model

* Created Order model

* 'Wishlist-Screen'

* Created about page

* Fixed the Renderflex Overflow issue

* Order Screen

* AdMob integration

* Gradle Version Upgrade

* fix: Issue 101

* issue #38 made manage address screen

* made changes to manage address

* Issues Resolved

* android, ios native splash screens added

* added ads on dashboard and product page

* Code Refactoring

* added code for faqs screen

* Added login screen(With all resolved changes)

* Update README.md

* Resolved all the changes

* made the changes

* Added google signin

* Added SignUp Screen

* Update CONTRIBUTING.md

Added linting rule statement

* Update pull_request_template.md

Added extra point to check for linting rules before merging

* fix: bump flutter version in the app release action

* Added the change username and password screen

* Project Structure Update

* Stacked Container Added

* Fixed Issue #151

* back to shop button on cart screen made to work.

* Added batches on top in Readme.md file

* Made the changes Issue #151

* Batches aligned at center

* resolved all the warnings

* Added T&C Screen Issue #38

* Added Email Auth #27

* Added Unknown Screen. Fixes Issue #161

* removed unknown route constant

* Firebase Remote Config

* Initialized remote config main

* Overflow problem in Settings Page

* Overflow problem in Settings Page

* Expanded the list view.
prevented the payment button to hide behind the ad banner in cart view.

* README.md file enhanced (#107)

* README.md enhanced

* README.md enhanced

* README.md enhanced

* README.md enhanced

* readme updated

* readme updated

* readme updated

* Login UI Update (#170)

* Added horizontal scroll to login page

* Resized widgets in login page

* Added space between text boxes in login page

Co-authored-by: AksV73 <[email protected]>

* Added in app web view for github repository link (#172)

* Code Cleanup

* Used FocusNode to shift from one TextFormField to another (#179)

* Made Logout button functional in Settings screen. Fixes #38 (#176)

* Made Logout Button Functional. Fixes #38

* Added all the features as instructed. Fixes #38

* Code Cleanup + UI Update

* Keep User Logged In (#181)

onAuthStateChanges Stream Added

* Fixes Issue #183. Added Privacy Policy Screen.

* added notificationsScreen (#184)

* made the new changes and squashed

* made changes

* fixed renderflex error

* Auth Update

* Fixes #190

* Deleted all the files.

* Fixes Issue #55

* Pushing the docs folder only.

Co-authored-by: Himanshu Sharma <[email protected]>
Co-authored-by: Smaranjit Ghose <[email protected]>
Co-authored-by: Anush Bhatia <[email protected]>
Co-authored-by: Ishan Sharma <[email protected]>
Co-authored-by: Anush Bhatia <[email protected]>
Co-authored-by: HIMANSHU SHARMA <[email protected]>
Co-authored-by: Vipul Sinha <[email protected]>
Co-authored-by: lordvins226 <[email protected]>
Co-authored-by: Tushar-OP <[email protected]>
Co-authored-by: ecrax <[email protected]>
Co-authored-by: Ajay <[email protected]>
Co-authored-by: Mansi169 <[email protected]>
Co-authored-by: “nb9960” <“[email protected]”>
Co-authored-by: Diksha Goyal <[email protected]>
Co-authored-by: Saransh <[email protected]>
Co-authored-by: Alifbhanvadiya14 <[email protected]>
Co-authored-by: Aayush Bisen <[email protected]>
Co-authored-by: Mohit <[email protected]>
Co-authored-by: sloth-panda <[email protected]>
Co-authored-by: Rahul Gandhi <[email protected]>
Co-authored-by: abhishek7997 <[email protected]>
Co-authored-by: Praneeth-rdy <[email protected]>
Co-authored-by: Pawan <[email protected]>
Co-authored-by: Sakshi Gupta <[email protected]>
Co-authored-by: D <[email protected]>
Co-authored-by: piyushpradhan <[email protected]>
Co-authored-by: Chirag <[email protected]>
Co-authored-by: Abhi-1313 <[email protected]>
Co-authored-by: Suyash Choudhary <[email protected]>
Co-authored-by: ThatOneTallKid <[email protected]>
Co-authored-by: Neha Musale <[email protected]>
Co-authored-by: Rupanshi Chawda <[email protected]>
Co-authored-by: Suyash Choudhary <[email protected]>
Co-authored-by: Apurv <[email protected]>
Co-authored-by: AJAYK-01 <[email protected]>
Co-authored-by: Aman Nanda <[email protected]>
Co-authored-by: samdid <[email protected]>
Co-authored-by: ADITI YADAV <[email protected]>
Co-authored-by: Rishabh Raizada <[email protected]>
Co-authored-by: DOOMSTERR <[email protected]>
Co-authored-by: Puru Ganda <[email protected]>
Co-authored-by: Mus2413 <[email protected]>
Co-authored-by: Anirudh Sai S B <[email protected]>
Co-authored-by: AksV73 <[email protected]>
Co-authored-by: AksV73 <[email protected]>
Co-authored-by: ShrutiJ-01 <[email protected]>
Co-authored-by: Sumit Didhate <[email protected]>
Co-authored-by: Muskan Jain <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation GSSOC21 Issues created for GSSOC'21 Level1 easy gssoc issue Level2 medium gssoc issue
Projects
None yet
Development

No branches or pull requests

4 participants