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.

Sign up for GitHub

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

Jump to bottom

docs: Add introduction section to documentation #843

Closed
wants to merge 1 commit into from
Closed

docs: Add introduction section to documentation #843

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions docs/modules/introduction_main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@

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

PythonRobotic aims to make robot development an enjoyable experience by easing the tedious process of algorithm creation.


Introduction to PythonRobotic
-----------------------------

PythonRobotic isn't just about cutting down your effort, it's about understanding and learning.
It's designed to be a useful resource for budding robotics enthusiasts looking to grasp the fundamental concepts behind each algorithm.
With its intuitive animations, PythonRobotic simplifies complex concepts, making simulations easily understandable in real-world applications.


Based on the principles of collaboration and knowledge sharing, PythonRobotic is an open source software (OSS).
This project includes a selection of practical algorithms that are widely adopted across academic and industrial domains, keeping you on the cutting edge of robotics development.


Each algorithm in PythonRobotic is coded in Python 3, one of the most popular and powerful programming languages in the world.
PythonRobotic is your go-to solution for effective and efficient robotic algorithm development, whether you're an amateur or an experienced professional.
We invite you to explore, learn, and contribute to our open source community, and look forward to being part of your exciting journey in the world of robotics.


What Is Open source software ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

TBD


Definition Of Robotics
----------------------

Expand Down
Loading