Skip to content

History

Revisions

  • 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.

    @petercorke petercorke committed Aug 17, 2026
    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

    @petercorke petercorke committed Aug 17, 2026
    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.

    @petercorke petercorke committed Aug 17, 2026
    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.

    @petercorke petercorke committed Aug 17, 2026
    69f2b7d
  • Updated What about Simulink (markdown)

    @petercorke petercorke committed May 18, 2023
    7703206
  • Created FAQ (markdown)

    @petercorke petercorke committed May 18, 2023
    6c0c94a
  • Updated _Sidebar (markdown)

    @petercorke petercorke committed May 18, 2023
    80db332
  • Destroyed Documentation convention (markdown)

    @jhavl jhavl committed Dec 24, 2022
    142d0f0
  • Updated Documentation Style Guide (markdown)

    @jhavl jhavl committed Dec 24, 2022
    eac825f
  • Created Documentation-Style-Guide (markdown)

    @jhavl jhavl committed Dec 24, 2022
    ca8b3a1
  • Updated _Sidebar (markdown)

    @jhavl jhavl committed Dec 24, 2022
    7dc1d15
  • Created Documentation Style Gudie (markdown)

    @jhavl jhavl committed Dec 24, 2022
    c598d62
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Apr 7, 2022
    f43e111
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Feb 28, 2022
    859f5be
  • Updated What about Simulink (markdown)

    @petercorke petercorke committed Feb 7, 2022
    4652419
  • Updated Scene graphs (markdown)

    @petercorke petercorke committed Feb 7, 2022
    9bbbf4b
  • Updated Scene graphs (markdown)

    @petercorke petercorke committed Feb 7, 2022
    c5e6876
  • Updated Scene graphs (markdown)

    @petercorke petercorke committed Feb 7, 2022
    ed2693c
  • Updated _Sidebar (markdown)

    @petercorke petercorke committed Feb 6, 2022
    c45a387
  • Created Scene graphs (markdown)

    @petercorke petercorke committed Feb 6, 2022
    02238f9
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Apr 19, 2021
    7f8e3bc
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Apr 19, 2021
    3846787
  • Minor VPython changes

    @micah-huth micah-huth committed Apr 16, 2021
    e3bea87
  • Updated _Sidebar (markdown)

    @petercorke petercorke committed Apr 12, 2021
    f72af6d
  • Updated Class introduction (markdown)

    @petercorke petercorke committed Apr 12, 2021
    f6c762d
  • Created Class introduction (markdown)

    @petercorke petercorke committed Apr 12, 2021
    6c3f0d7
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Apr 7, 2021
    26c67bc
  • Updated Common Issues (markdown)

    @jhavl jhavl committed Apr 7, 2021
    af8532b
  • Updated Contributing (markdown)

    @petercorke petercorke committed Apr 5, 2021
    0b051c8
  • Updated Contributing (markdown)

    @petercorke petercorke committed Apr 4, 2021
    fa161f9