-
Notifications
You must be signed in to change notification settings - Fork 140
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
docs: rework structure #205
base: main
Are you sure you want to change the base?
Conversation
Here’s a revised draft of your comment incorporating the additional context: Hi @ismaelfaro, Thank you for updating the documentation with these structure and architecture diagrams! I reviewed the changes, and I find them incredibly useful, especially for developers new to this framework. Clear and detailed documentation like this not only improves onboarding but also aligns with modern development workflows. For the issue I’m currently working on, my first step was to generate additional documentation—both for the framework as a whole and specifically for the issue I was addressing. This documentation served a dual purpose: helping me better understand the framework and providing structured context for an LLM to assist in drafting the initial implementation of the code. From this perspective, I fully agree that improvements like the ones in this PR are not just enhancements but necessary steps for supporting new "developer workflows" that start by creating a solid understanding and leveraging LLMs as a tool to explore solutions. Great work on this PR! |
5ee45d2
to
5561b8f
Compare
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
5561b8f
to
303cce9
Compare
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
08dd7b8
to
aa1c1b1
Compare
Signed-off-by: Ismael Faro <[email protected]>
Which issue(s) does this pull-request address?
updating Docs to adding structure and architecture diagrams.
Closes: #
Description
Checklist
yarn lint
oryarn lint:fix
yarn format
oryarn format:fix
yarn test:unit
yarn test:e2e