Fix README accuracy and tidy docs/code comments - #5
Merged
Conversation
- The intro said the whole stack runs in `docker compose up`; it doesn't. The naturalnav service's default command only starts the planner, executor, and detector, not Gazebo/Nav2. Rewritten to describe the actual setup. - Dropped an unclear, non-functional sentence from the intro. - General prose and punctuation cleanup across README, Dockerfile, docker-compose.yml, and code comments/docstrings. No functional changes.
Decorative box-drawing dividers replaced with plain comments across fleet_orchestrator.py, llm_planner.py, semantic_detector.py, Dockerfile, docker-compose.yml, and the legacy world file. No functional changes.
…-and-style # Conflicts: # Dockerfile
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
docker compose up; it doesn't.The naturalnav service's default command only starts the planner, executor,
and detector, not Gazebo/Nav2. Rewritten to describe the actual setup.
docker-compose.yml, and code comments/docstrings. No functional changes.