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: Add introduction section to documentation #843
docs: Add introduction section to documentation #843
Conversation
@AtsushiSakai please review PR |
@AtsushiSakai Could you please let me know what you think about this PR ? If you like it or not, please let me know. |
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.
Sorry for my late review. PTAL.
Introduction | ||
============ | ||
============================================== | ||
Welcome to the PythonRobotic Documentation 👋 |
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.
PythonRobotic -> PythonRobotics
Welcome to the PythonRobotic Documentation 👋 | ||
============================================== | ||
|
||
Welcome to PythonRobotic's comprehensive documentation, an open source collection of tried-and-tested robotics algorithms designed to simplify and expedite your robotics journey. |
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.
I'm sorry for the confusion, but I'd like this Introduction chapter to be a general introduction to robotics, not specifically to this OSS. However, I think this text is excellent, so could you please move it to the 'Getting started' page? https://atsushisakai.github.io/PythonRobotics/getting_started.html"
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.
Ok , I'm moving this text to the “Getting started' page”.
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.
Can I describe a little bit about OSS in the introduction section?
Like many users do not know what exactly OSS means. It would be good to add a brief description of OSS in the introduction section.
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.
@AtsushiSakai Done , Please review it.
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.
Sorry for my late review. PTAL.
Add the introduction section to the documentation.
changes