Skip to content

docs: fix all broken links in README#1298

Merged
spomichter merged 1 commit intoivan/maindocs2from
docs/fix-readme-links
Feb 19, 2026
Merged

docs: fix all broken links in README#1298
spomichter merged 1 commit intoivan/maindocs2from
docs/fix-readme-links

Conversation

@spomichter
Copy link
Contributor

Fixes 18 broken links in README.md:

docs/api/*docs/usage/* (7 links)

  • Modules, LCM, Blueprints, Transports, Data Streams, Configuration, Visualization

Broken anchors

  • #hardware#platforms (heading is # Platforms)

Wrong file paths

  • docs/platforms/todo.mddocs/todo.md (5 experimental platform links)
  • docs/installation/docker.mddocs/todo.md (doesn't exist yet)
  • ROS interop transport link

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 19, 2026

Greptile Summary

This PR fixes remaining broken links in the README after the directory restructuring from docs/api/ to docs/usage/.

Changes made:

  • Fixed 2 anchor link references from #hardware to #platforms to match the actual section heading
  • Corrected 5 experimental platform links from non-existent docs/platforms/todo.md to docs/todo.md
  • Updated Docker installation link from non-existent docs/installation/docker.md to docs/todo.md

All target files have been verified to exist. This is a documentation-only change with no functional impact.

Confidence Score: 5/5

  • This PR is completely safe to merge with zero risk
  • Documentation-only changes that fix broken internal links. All target files have been verified to exist. No code changes, no functional impact, no risk.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Fixed 8 broken links: updated anchor references from #hardware to #platforms, corrected platform todo paths, and fixed Docker installation link

Last reviewed commit: 412fdce

@spomichter spomichter force-pushed the docs/fix-readme-links branch from 412fdce to da0e470 Compare February 19, 2026 07:53
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

- docs/api/* → docs/usage/* (7 links: modules, lcm, blueprints, transports, data_streams, configuration, visualization)
- #hardware anchor → #platforms (matches actual heading)
- docs/platforms/todo.md → docs/todo.md (5 experimental platform links)
- docs/installation/docker.md → docs/todo.md (file doesn't exist yet)
- ROS interop transport link fixed
@spomichter spomichter force-pushed the docs/fix-readme-links branch from da0e470 to a407bb5 Compare February 19, 2026 07:55
@spomichter spomichter merged commit e4b7f81 into ivan/maindocs2 Feb 19, 2026
1 check passed
@spomichter spomichter deleted the docs/fix-readme-links branch February 19, 2026 07:57
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant