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

doc: documentation of the Immich Flutter Architectural Pattern #5748

Merged
merged 2 commits into from
Dec 17, 2023

Conversation

Skyquek
Copy link
Contributor

@Skyquek Skyquek commented Dec 16, 2023

Description

Added the Immich Flutter architectural documentation on Readme.md. The current readme.md is empty, figured out that we can use the Readme.md to document the architectural pattern on Flutter.

@alextran1502
Copy link
Contributor

is this from ChatGPT or Bard?

@alextran1502 alextran1502 changed the title Added Documentation of the Immich Flutter Architectural Pattern doc: documentation of the Immich Flutter Architectural Pattern Dec 16, 2023
@Skyquek
Copy link
Contributor Author

Skyquek commented Dec 16, 2023

Ya, this is from ChatGPT. I use it clean up my grammar. But the explaination is correct right? The flutter do use provider pattern organization with the separation of the Ui, view, provider, services, model

@alextran1502 alextran1502 added the documentation Improvements or additions to documentation label Dec 17, 2023
@alextran1502
Copy link
Contributor

alextran1502 commented Dec 17, 2023

Ya, this is from ChatGPT. I use it clean up my grammar. But the explaination is correct right? The flutter do use provider pattern organization with the separation of the Ui, view, provider, services, model

Some parts has more sugar and are not necessarily correct, but overall very good

@alextran1502 alextran1502 enabled auto-merge (squash) December 17, 2023 17:47
@alextran1502 alextran1502 merged commit 27f8dd6 into immich-app:main Dec 17, 2023
18 checks passed
@Skyquek Skyquek deleted the Document-Flutter-Mobile branch December 18, 2023 03:56
@benjamonnguyen
Copy link

Thanks for the documentation @Skyquek!

I'm curious about the prompt you provided to generate this. Did you pass in parts of the codebase?

@Skyquek
Copy link
Contributor Author

Skyquek commented Dec 20, 2023

@benjamonnguyen I passed the tree directory structure and write the intial Readme.md. Then ask CHatGPT to improve on it.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants