docs: fix README API section links to correct docs/usage/ paths#1297
Merged
spomichter merged 1 commit intoivan/maindocs2from Feb 19, 2026
Merged
docs: fix README API section links to correct docs/usage/ paths#1297spomichter merged 1 commit intoivan/maindocs2from
spomichter merged 1 commit intoivan/maindocs2from
Conversation
All documentation lives under docs/usage/, not docs/api/. Fixed: - Modules, LCM, Blueprints, Configuration, Visualization links - Transports link (now points to docs/usage/transports/index.md) - Data Streams links (both in feature grid and API section) - ROS interop section transport link
Contributor
Greptile SummaryFixed broken internal documentation links in README.md by updating paths from non-existent
Confidence Score: 5/5
Important Files Changed
Last reviewed commit: e3fecfd |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
spomichter
added a commit
that referenced
this pull request
Feb 19, 2026
* move, no fixed links * fix renamed references * add missing assets * fix doclink tests * Update docs/usage/README.md * - * testing inline ascii art * adjusting ascii * ascii adjust * micro adjustments * readme * readme * svg logo tests * light/dark svg * alignment * alignment attemps * testing raw ascii * trying to fix rendering * fixing centering * shifting * cleanup * .. * testing table * size * new table row * added agents * watch video links * hr * table ased lines * .. * checking if diff branch triggers CI * code cleanup run only on PR * better detections image * renamed to rerender * .. * .. * maybe svg is better * I'm sorry to say svg is better * .. * .. * .. * .. * .. * .. * .. * nav gif * better nav gif * .. * correct table * hardware links * .. * .. * go2 link test * .. * hw links * .. * structure * .. * .. * install * .. * .. * upload gif * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * torque * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * docs: add Go2 non-ROS navigation docs, update README, pull agent docs - Add Go2 native navigation documentation with pipeline step images - Update README with shields badges, hardware table, nav links - Pull docs/agents and dimos/utils/docs from main - Add hardware integration guide placeholder - Rename sensor_streams to data_streams * ... * fix graph * native nav docs wrap * nav wrap * docs: fix pikchr diagram - labels above/below, dashed Twist arrow * diagram fixed * .. * .. * .. * .. * docs: link CostMapper heading to source file in nav docs * .. * .. * .. * .. * agents doc * API renamed to usage * docs: fix README API section links to correct docs/usage/ paths (#1297) All documentation lives under docs/usage/, not docs/api/. Fixed: - Modules, LCM, Blueprints, Configuration, Visualization links - Transports link (now points to docs/usage/transports/index.md) - Data Streams links (both in feature grid and API section) - ROS interop section transport link * Update docs/installation/nix.md * Fix virtual environment activation path in nix.md * docs: fix all broken links in README (#1298) - #hardware anchor → #platforms (matches actual heading) * docs(readme): link drone and mavlink entries to dimos/robot/drone (#1299) * per os install instructions * Update video links and text in README * main readme install update * typos/small fixes for install * typos, small fixes for main readme * Update installation instructions and remove guide link Removed outdated hardware integration guide link and updated Ubuntu version in installation instructions. * Added new gifs, spatial memory * updated gifs * docs(readme): nav description, quickstart with real examples, remove dead perception link (#1301) * docs(readme): nav description, quickstart with real examples, remove dead perception link * fix: revert perception description, only remove dead video link * Revise Python installation and development instructions Updated installation instructions and quickstart section for clarity and added emphasis on development. * readme changes * Revise README title and introduction for clarity Updated the title and description to reflect the agentive nature of the operating system. * Readme updates * Update README.md * Readme updates * Readme updates * CI code cleanup * docs(readme): add Unitree B1 to quadruped hardware table (#1302) * docs(transports): fix broken image paths — assets/ → ../assets/ (#1303) --------- Co-authored-by: Jeff Hykin <jeff.hykin@gmail.com> Co-authored-by: s <pomichterstash@gmail.com> Co-authored-by: spomichter <12108168+spomichter@users.noreply.github.com>
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.
Summary
Fix broken internal links in README.md. All documentation lives under
docs/usage/, notdocs/api/.Changes
docs/usage/modules.mddocs/usage/lcm.mddocs/usage/blueprints.mddocs/usage/transports/index.mddocs/usage/data_streams/README.mddocs/usage/configuration.mddocs/usage/visualization.mdAll 10
docs/api/references in README.md replaced with correct paths.