Remove five 2020 design-note pages, fold the live decisions into the Style Guide
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
7ec428c
Dynamics: summary table of the RNE implementations
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
3831c02
Update Dynamics: friction and gear ratio, payload and payload_capacity
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
3408cdc
Update Kinematics: ikine_analytic, ik_XX limits, joint offsets, ETS merge/swap/replace
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
ec4a8c2
Update Backends: view/color, several robots in one scene, Swift defaults and notebook
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
9993880
Rewrite Working with Jupyter: where notebooks run, plotting, bootstrap cell
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
a929e2b
Style guide: rubric headings, .. seealso:: not :seealso:, indented runblock, plot, version notices
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
38d88b8
swap research and benchmark sections
139cc04
Add Benchmarks section: IK solver speed, RNE speed
Companion pages for examples/benchmark_ik.py and examples/benchmark_rne.py
(renamed from ik_speed.py/rne_speed.py).
5fcc782
Add Research section: Reactive control and Inverse kinematics pages
Moves the "Toolbox Research Applications" paper list out of the
repo's README (which now just links here) and into two dedicated
wiki pages, fleshed out beyond title+links:
- Reactive-control.md: the four QP/reactive-controller papers
(NEO, Holistic mobile manipulation, Visibility Maximization,
Purely-Reactive Manipulability-Maximising), each with a short
plain-language description, plus jhavl.github.io/neo/. Code-example
links fixed to the current examples/ path (README's old links
pointed at roboticstoolbox/examples/, stale since the src/ layout
migration).
- Inverse-kinematics.md: new page covering the two-part "Manipulator
Differential Kinematics" tutorial (Haviland & Corke, IEEE RAM 2023,
arXiv:2207.01796/2207.01794 -- already IK.py's own cited reference)
and the companion jhavl/dkt notebook repo.
Both cross-link each other and the existing Kinematics/Key-concepts
pages. Added under a new "Research" section in the sidebar.
1aa4557
Panda-models.md: add DH.Panda, link to #688
DH.Panda() belongs in this page too -- it's the fourth Panda-family
model, and its own inertial data has the same "ported without
verified frame equivalence" history as the caution this page already
gives against porting DH data into a URDF model. Adds it to the
summary table and a note (with the #688 cross-check results:
gravity torque exact match, inertia matrix within ~1%) in the DH
history section.
3010fd6
Add Panda models page: vendored vs robot_descriptions tradeoff
Explains why Panda()/Frankie()/FrankieOmni() load different underlying
URDF data (bundled qut_frankie_description xacro vs robot_descriptions),
the resulting inertial-data gap in the bundled model, the DH.Panda()
history (issue #278/PR #294) and why that fix doesn't transfer to URDF
models, and the measured collision-query performance tradeoff (~12x
slower link_collision_damper() with robot_descriptions' mesh geometry
vs the bundled capsule approximation) that's the reason
Panda(use_robot_descriptions=True) is an opt-in rather than the new
default. Companion to PR #687 and issue #686.
Also cross-links from Models.md, and adds the page to _Sidebar.md.
014bd12
rtbtool.md: drop stray quote in banner, matching the source fix
The banner shown here faithfully quoted a real bug in
src/roboticstoolbox/bin/rtbtool.py's make_banner() (a stray trailing "
after the last import line) -- fixed on main in
petercorke/robotics-toolbox-python#678.
1f2d219
Fix drift found in wiki review: factual errors, remove ROS, migrate desiderata to Issues
Factual errors fixed:
- Dynamics.md: Link.friction(q) -> Link.friction(qd), friction is a function
of joint velocity not position
- Grippers.md: rewritten from a 2020/2021 "discussion document, not
implemented" framing to describe the actual shipped Gripper class and
robot.grippers list, with real examples from Frankie/Fetch
- Kinematics.md: the "robots with multiple end effectors" section called
this "just speculation so far" with a made-up API; fkine/ikine_* already
ship end=/start= kwargs for exactly this, documented instead
- Coding-conventions.md: import typos (`script` -> `scipy`, `ppt` -> `plt`,
a stray backtick) that didn't match the actual codebase convention
ROS backend, per explicit decision -- not done, unclear if/when it will be,
so drop all mention rather than document vapourware:
- Delete ROS.md entirely
- Backends.md: drop the ## ROS section
- Contributing.md, Background.md: drop ROS mentions
Desiderata migrated to GitHub Issues (#673-#677), same rationale as the
tech-debt.md -> Issues migration: a wiki page can't be closed when the work
lands, which is exactly how Grippers.md and the ROS/Contributing mismatch
went stale. Contributing.md's "What needs doing" and Backends.md's TODO
section now point at the issues instead of listing items inline.
Also: Background.md gets a currency footnote (Python version, LGTM
shutdown) rather than presenting 2020 design goals as current status;
Scene-graphs.md gets a "superseded by Swift/SpatialGeometry" note and
moves from "Development (current)" to "OLD" in the sidebar, since that's
what it actually is; Home.md's one-line landing page gets a real intro
with navigation pointers.
2d7d21b
Delete duplicate pages: Documentation-Style-Gudie, What-about-Simulink?
Documentation-Style-Gudie.md was a typo'd duplicate of
Documentation-Style-Guide.md (renamed 3 minutes before the correctly-
spelled page was created, never cleaned up).
What-about-Simulink.md and What-about-Simulink?.md forked after a
filename rename dropped the "?" (awkward in wiki URLs) without deleting
the old file; the two were then edited independently and diverged. Keep
the cleaner prose (from the ?-suffixed original) under the plain
filename, which is what _Sidebar.md actually links to; delete the other.
5c10889
Fix medium-priority drift: Contributing, Contributors, Coding-conventions, Key-concepts, Introduction, Link-frame docs
- Contributing.md: fix broken Documentation-convention link, drop the
dead Kristian-dev-updated branch reference (mobile robotics has long
since landed on main with tests and docs), note ROS/Dynamixel backends
already exist
- Contributors.md: urdfpy/xacro attribution is stale (neither is used
anymore) -- xacro preprocessing is via the xacrodoc dependency now;
DynamixelSDK attribution confirmed still accurate (still vendored)
- Coding-conventions.md: fix broken Documentation-convention link,
replace the dead LGTM.com reference (shut down Dec 2022) with an
honest note that RTB has no replacement quality-grade tool wired in,
add a ruff mention
- Key-concepts.md: ETSRobot -> ERobot (actual current class name)
- Introduction-to-robot-and-link-classes.md: IK_xx -> the real
ikine_a/ikine_NR/ikine_LM/ikine_GN/ikine_QP method names
- Link-frame-and-joint-definitions.md: replace the dead
render.githubusercontent.com math-image hack with native GFM math
($...$), which GitHub added wiki-wide support for after this page was
last touched
88a1f65
Merge Common-Issues into FAQ, polish Documentation-Style-Guide wording
FAQ.md was a stub ("none yet") sitting next to a fully-populated
Common-Issues.md that was doing FAQ's actual job under a different
name. Merge Common-Issues' content into FAQ.md and delete
Common-Issues.md; update _Sidebar.md accordingly.
Add a "Matplotlib version issues" section to the merged FAQ, summarizing
https://github.com/petercorke/RVC3-python/issues/21 (unpinned matplotlib
is deliberate, not an oversight; the specific Slider-widget breakage
that prompted the issue is fixed upstream as of matplotlib 3.11).
Also trim two lines of meta-commentary from Documentation-Style-Guide.md
that narrated the page's own edit history rather than just stating
current practice.
5984f38
Rewrite Documentation-Style-Guide: numpy style -> reST style
The page described the NumPy docstring convention (Parameters/Returns
section headers) as current practice. The codebase has used reST-style
docstrings (:param:, :returns:) throughout for a long time -- this page
was just never updated to match. Rewritten per rvc-ecosystem/AGENTS.md
Sec 5 (Code Standards), the canonical source shared across RTB/MVTB/SMTB/
bdsim. Also corrected the "Restructured Text for Built Docs" section,
which described an autosummary/:toctree: stubs pattern that isn't
actually used anywhere in the current docs -- real pages use plain
automodule/autoclass.
Delete Coding-Standard.md, a 7-line page fully subsumed by the more
detailed Coding-conventions.md.
69f2b7d
Updated What about Simulink (markdown)
7703206
Updated _Sidebar (markdown)
80db332
Destroyed Documentation convention (markdown)
jhavl
committed
Dec 24, 2022
142d0f0
Updated Documentation Style Guide (markdown)
jhavl
committed
Dec 24, 2022
eac825f
Created Documentation-Style-Guide (markdown)
jhavl
committed
Dec 24, 2022
ca8b3a1
Updated _Sidebar (markdown)
jhavl
committed
Dec 24, 2022
7dc1d15
Created Documentation Style Gudie (markdown)
jhavl
committed
Dec 24, 2022
c598d62
Updated Common Issues (markdown)
jhavl
committed
Apr 7, 2022
f43e111
Updated Common Issues (markdown)
jhavl
committed
Feb 28, 2022
859f5be
Updated What about Simulink (markdown)
4652419
Updated Scene graphs (markdown)
9bbbf4b