-
Notifications
You must be signed in to change notification settings - Fork 4
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] Enhance documentation with Quick Start Guide and Detailed System Requirements #42
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Co-authored-by: MariaMakeeva <[email protected]> Signed-off-by: Aleksandr Zimin <[email protected]>
Co-authored-by: MariaMakeeva <[email protected]> Signed-off-by: Aleksandr Zimin <[email protected]>
AleksZimin
force-pushed
the
docs-improve
branch
from
February 22, 2024 14:51
7ab4888
to
32aea73
Compare
Signed-off-by: MariaMakeeva <[email protected]>
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
AleksZimin
commented
Feb 22, 2024
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
AleksZimin
changed the title
[docs] Improve
[docs] Enhance documentation with Quick Start Guide and Detailed System Requirements
Feb 28, 2024
4 tasks
kirkonru
approved these changes
Feb 29, 2024
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.
Did some minor edits, mostly to get rid of a typo we discussed in the Slack thread.
Co-authored-by: Kirill Kononovich <[email protected]> Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Kirill Kononovich <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Signed-off-by: Aleksandr Zimin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR enriches our documentation by introducing a 'Quick Start' section, designed to help new users easily get up and running with our solution. We have also expanded the 'System Requirements and Recommendations' section, providing users with a comprehensive understanding of the hardware and software prerequisites for optimal performance.
Why do we need it, and what problem does it solve?
User Onboarding: The 'Quick Start' section significantly lowers the entry barrier for new users, offering step-by-step guidance for setting up our solution quickly.
Informed Setup: By detailing system requirements and recommendations more thoroughly, users can prepare their environment more effectively, ensuring compatibility and optimal performance.
What is the expected result?
Checklist