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.

Sign up for GitHub

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

Jump to bottom

(frontend)[AGE 1444]: Enhance documentation for Frontend repo, and include best practices #2356

Merged
merged 7 commits into from
Dec 11, 2024
Merged

(frontend)[AGE 1444]: Enhance documentation for Frontend repo, and include best practices #2356

merged 7 commits into from
Dec 11, 2024

Conversation

ardaerzin
Copy link
Contributor

@ardaerzin ardaerzin commented Dec 9, 2024 •
edited
Loading

closes AGE-1444
closes AGE-1445
closes AGE-1446

What has changed?

  • added editor setup tips for having better eslint & prettier support while working on the Frontend code
  • added an example for the new proposed folder structure
  • added a section with examples on unification & simplification of our data operations
  • added a section on data memoization to prevent & eliminate some issues I've seen in the codebase

This'll be a living document, but this iteration should be enough to give a better structure to upcoming PRs. Looking forward to your feedback

@vercel Vercel
Copy link

vercel bot commented Dec 9, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
agenta ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 2:55pm
agenta-documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 2:55pm

mmabrouk
mmabrouk approved these changes Dec 9, 2024
View reviewed changes
Copy link
Member

@mmabrouk mmabrouk left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ardaerzin not the expert but it's very clear to me.
One point that's still open is ee/ -> Saw your comment

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 9, 2024
aybruhm
aybruhm approved these changes Dec 9, 2024
View reviewed changes
Copy link
Member

@aybruhm aybruhm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ardaerzin ardaerzin marked this pull request as ready for review December 9, 2024 15:11
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation Frontend labels Dec 9, 2024
ashrafchowdury
ashrafchowdury reviewed Dec 10, 2024
View reviewed changes
Copy link
Collaborator

@ashrafchowdury ashrafchowdury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about FE testing??

jp-agenta
jp-agenta approved these changes Dec 10, 2024
View reviewed changes
Copy link
Contributor

@jp-agenta jp-agenta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@bekossy
Copy link
Member

bekossy commented Dec 10, 2024

Thank you for the PR, @ardaerzin. LGTM! One thought: should we consider adding a section to discuss when and why to import a component dynamically?

aakrem
aakrem approved these changes Dec 10, 2024
View reviewed changes
Copy link
Collaborator

@aakrem aakrem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ardaerzin
Copy link
Contributor Author

Thank you for the PR, @ardaerzin. LGTM! One thought: should we consider adding a section to discuss when and why to import a component dynamically?

will add a follow up ticket this week, and make sure it includes the additional topics mentioned here. Thanks for the feedback 🙏

@ardaerzin
Copy link
Contributor Author

How about FE testing??

We're already discussing this topic. once it is a refined more, will share with the team and include them in an updated version of this

@ardaerzin ardaerzin merged commit 03a38ca into main Dec 11, 2024
9 checks passed
@ardaerzin ardaerzin deleted the AGE-1444/enhance-working-with-frontend-documentation branch December 11, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jp-agenta jp-agenta jp-agenta approved these changes

@bekossy bekossy bekossy approved these changes

@ashrafchowdury ashrafchowdury ashrafchowdury approved these changes

@aybruhm aybruhm aybruhm approved these changes

@aakrem aakrem aakrem approved these changes

@mmabrouk mmabrouk mmabrouk approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Frontend lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ardaerzin @bekossy @mmabrouk @aakrem @aybruhm @ashrafchowdury @jp-agenta