-
Notifications
You must be signed in to change notification settings - Fork 216
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
github.io documentation restructuring #909
github.io documentation restructuring #909
Conversation
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a fantastic PR! The reorganization of the documentation is a massive improvement and it's clear that a lot of effort has been put into this. The structure is much more intuitive and user-friendly, which will be appreciated by all the users!.
I really like the sections:
- Features page, the addition of the Features/ aggregation algorithms <- liked!
- Contributing to OpenFL <- especially this
- Releases
- Blog and Publications
I only request changes on minor comments or typos.
This is a significant contribution. Well done Kevin!
I realized I forgot to mention something in my previous comment. I've been thinking that perhaps we should consider adding a [+] icon to indicate where sections can be expanded. However, I'm a bit torn on this. On one hand, it could enhance user navigation and ensure that no sections are overlooked. On the other hand, it might detract from the minimalist aesthetic that I really appreciate in the current design. It's a minor point, but I thought it was worth bringing up for discussion. Anyway, great job on this PR! |
Signed-off-by: kta-intel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already reviewed and look great and ready for the merge!
@kta-intel once the conflicts with |
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
Signed-off-by: kta-intel <[email protected]>
I think it should be good now. I'm not sure the exact cause of the merge conflict, but pulling the original Ran a final check to make sure everything ran as it did before. Thanks again everyone for the review! |
* updating documentation template Signed-off-by: kta-intel <[email protected]> * WIP quickstart guide Signed-off-by: kta-intel <[email protected]> * documentation updates Signed-off-by: kta-intel <[email protected]> * more updates to getting started Signed-off-by: kta-intel <[email protected]> * more get_started docs Signed-off-by: kta-intel <[email protected]> * getting_started updates Signed-off-by: kta-intel <[email protected]> * documentation overhaul. restructuring github.io Signed-off-by: kta-intel <[email protected]> * lint fix Signed-off-by: kta-intel <[email protected]> * addressing various comments, fixing typos, code snippets, etc Signed-off-by: kta-intel <[email protected]> * add /docs/workflow_interface.rst Signed-off-by: kta-intel <[email protected]> * remove /docs/workflow_interface.rst Signed-off-by: kta-intel <[email protected]> * add add /docs/workflow_interface.rst Signed-off-by: kta-intel <[email protected]> * remove /docs/workflow_interface.rst Signed-off-by: kta-intel <[email protected]> * fixing typo in workflowinterface.rst Signed-off-by: kta-intel <[email protected]> --------- Signed-off-by: kta-intel <[email protected]>
Description: This PR restructures the current github.io. Contents are intact and migrated from the old documentation with minor updates and additions
Objective:
Added: