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] Editing Paths #731

Open

9 tasks

shueja opened this issue Sep 17, 2024 · 0 comments

Labels

component: documentation

Milestone

Collaborator

shueja commented Sep 17, 2024

https://sleipnirgroup.github.io/Choreo/usage/editing-paths/

Update all screenshots
Remove mentions of units of inputs, irrelevant under math parsing

WAYPOINTS

Fix description of Translation waypoint (does not show circle, heading not used in initial guess)
Describe relationship between empty waypoints and constraints, vs unconstrained empty points being initial guess.
Remove Initial Guess Point
Add section describing Samples override input (available on all waypoint types)
Add section describing Split toggle per-waypoint, what it does to path loading, and advice for use cases

CONSTRAINTS

Update list of constraints and definitions
Maybe describe the process of adding a constraint and editing the ui overlay for it?
** OBSTACLES**
These are getting rolled in with constraints and renamed to Keep Out Circles/Rects

EVENT MARKERS
Rename to PathPlanner Events, or similar.
Mostly unchanged, some parts mention stop points and exporting. This needs to be updated.

NEW: CHOREOLIB EVENTS

shueja added the component: documentation label

shueja added this to the 2025-docs-dev milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment