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.

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

Conversation

Faizan-Alam-1
Copy link
Contributor

Add the introduction section to the documentation.

changes

1 into 2 into

@Faizan-Alam-1
Copy link
Contributor Author

@AtsushiSakai please review PR

@Faizan-Alam-1
Copy link
Contributor Author

@AtsushiSakai Could you please let me know what you think about this PR ? If you like it or not, please let me know.

Copy link
Owner

@AtsushiSakai AtsushiSakai left a 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 👋
Copy link
Owner

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.
Copy link
Owner

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"

Copy link
Contributor Author

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”.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

#845

Copy link
Owner

@AtsushiSakai AtsushiSakai left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants