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

update README and kraken_nav/README #272

Merged
merged 4 commits into from
Dec 20, 2023

Conversation

jhanca-robotecai
Copy link
Contributor

@jhanca-robotecai jhanca-robotecai commented Dec 15, 2023

There are some inconsistencies and duplications between the main README.md and kraken_nav/README.md files. The major problem was indicated recently in #270 and #271: one of the readme files was suggesting usage of main branches, while the other one was pointing to development branches of o3de and o3de-extras. This is fixed now. Additionally, a comment about 2310.1 release was added - this should be a default version for all users.

Creating this PR to be merged into development. Following this change, the development branch should be merged into the main branch, as this codebase was thoroughly tested with 2310.1 and works correctly. The current HEAD of main branch was last updated on Dec 1, 2022 - it is time to update it.

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
@jhanca-robotecai
Copy link
Contributor Author

Switching to draft, docs/ImportingURDF/URDF_import_guide.md needs a rework after changes in Robot Importer in last year

@jhanca-robotecai jhanca-robotecai marked this pull request as draft December 15, 2023 20:42
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
@jhanca-robotecai
Copy link
Contributor Author

Based on the internal discussion with @adamdbrw it was decided to completely remove the outdated URDF import guide from this repository and add it in the form of a tutorial in the documentation: o3de/o3de.org#2531

@jhanca-robotecai jhanca-robotecai marked this pull request as ready for review December 18, 2023 12:41
Copy link
Contributor

@arturkamieniecki arturkamieniecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Minor change needed.

README.md Outdated Show resolved Hide resolved
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
Co-authored-by: Artur Kamieniecki <artur.kamieniecki@robotec.ai>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
@michalpelka michalpelka merged commit fd79b0f into development Dec 20, 2023
1 check passed
@jhanca-robotecai jhanca-robotecai deleted the jhanca-robotecai/update_readme branch December 20, 2023 11:14
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.

3 participants