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] Update Editing Paths section for 2025 #825

Draft

shueja wants to merge 1 commit into SleipnirGroup:main from shueja:editing-paths-docs

Collaborator

shueja commented Oct 3, 2024 •

edited

Loading

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


          Edit waypoint section and constraints

8cdd1c0

shueja changed the title ~~Editing paths docs~~ [docs] Update Editing Paths section for 2025

shueja changed the base branch from 2025-docs-dev to main

October 3, 2024 05:42

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

Labels

None yet