WIP maindocs

[leshy]

No description provided.

[greptile-apps]

Greptile Overview

Greptile Summary

This WIP PR consolidates the documentation structure by merging the separate docs/api/ and docs/concepts/ directories into a single docs/usage/ directory, and simplifies the docs/development/writing_docs/ multi-file guide into a single writing_docs.md file. It also adds a draft NEWREADME.MD with a new ASCII art banner and stub sections.

• Doc restructure: All files from docs/api/ and docs/concepts/ moved to docs/usage/, with internal cross-references updated throughout the codebase (README, examples, tests, doclinks utility).
• Writing docs simplified: The 3-file writing_docs/ directory (codeblocks, diagrams, doclinks guides + SVG assets) replaced by a concise 7-line writing_docs.md.
• Broken link in README.md: The Streams link points to sensor_streams/index.md which doesn't exist — should be sensor_streams/README.md.
• NEWREADME.MD issues: Unclosed <div> tag and likely "ubuntu 2.4" typo (should be "Ubuntu 24.04"). File is clearly WIP/placeholder.
• No remaining stale references: All internal references to the old docs/api/ and docs/concepts/ paths have been updated — no broken links to old locations remain in the working tree.

Confidence Score: 4/5

• This is a documentation-only restructure with no functional code changes; safe to merge with minor fixes.
• Score of 4 because this is purely a documentation reorganization with no runtime code changes. The doc moves are clean and internal references have been comprehensively updated. Deducted 1 point for the broken sensor_streams link in README.md and the incomplete NEWREADME.MD (unclosed div, typo). These are minor issues that don't affect system behavior.
• NEWREADME.MD (unclosed HTML tag, typo) and README.md (broken sensor_streams/index.md link)

Important Files Changed

Filename	Overview
NEWREADME.MD	New WIP draft README with ASCII art banner and stub sections (Features, Hardware, Installation). Has unclosed div tag and a likely "ubuntu 2.4" typo.
README.md	Updated doc links from docs/api/ and docs/concepts/ to docs/usage/. The Streams link still points to nonexistent index.md instead of README.md.
dimos/utils/docs/doclinks.py	Comment-only change updating example path from docs/concepts/ to docs/usage/. No functional change.
dimos/utils/docs/test_doclinks.py	Test paths updated from docs/concepts/ and docs/api/ to docs/usage/. Assertion updated from checking for "../" to checking for the exact expected link output.
docs/development/README.md	Updated writing docs link from directory path to new single-file path.
docs/development/writing_docs.md	New simplified writing docs guide replacing the old writing_docs/ directory with 3 concise guidelines. Significantly shorter than the original multi-file guide.
docs/usage/README.md	New consolidated usage landing page, replacing both docs/concepts/README.md and docs/api/README.md. Links updated to docs/usage/ paths.
examples/simplerobot/README.md	Updated transforms link from docs/api/ to docs/usage/.

Flowchart

flowchart TD
    subgraph "Before (deleted)"
        A1["docs/api/"] --> A2["configuration.md\ntransforms.md\nvisualization.md\nsensor_streams/"]
        B1["docs/concepts/"] --> B2["modules.md\nblueprints.md\ntransports.md\nlcm.md"]
        C1["docs/development/writing_docs/"] --> C2["README.md\ncodeblocks.md\ndiagram_practices.md\ndoclinks.md\nassets/"]
    end

    subgraph "After (new structure)"
        D1["docs/usage/"] --> D2["modules.md\nblueprints.md\nconfiguration.md\ntransforms.md\ntransports.md\nlcm.md\nvisualization.md\nsensor_streams/"]
        E1["docs/development/writing_docs.md"]
    end

    A1 -- "merged into" --> D1
    B1 -- "merged into" --> D1
    C1 -- "replaced by" --> E1

Loading

_{Last reviewed commit: 3c553bd}

[greptile-apps]

_{57 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

Broken link: index.md does not exist

The Streams link points to /docs/usage/sensor_streams/index.md, but the actual file at that location is README.md. This was a pre-existing broken link (/docs/api/sensor_streams/index.md) that was partially updated in this PR — the directory was corrected from api to usage, but the filename was not fixed.

Suggested change

	- [Streams](/docs/usage/sensor_streams/index.md): How modules communicate, a Pub / Sub system.
	- [Streams](/docs/usage/sensor_streams/README.md): How modules communicate, a Pub / Sub system.

[greptile-apps]

Likely typo: "ubuntu 2.4"

This looks like it should be "Ubuntu 24.04" (the LTS release). The current text reads as a version "2.4" which doesn't correspond to any Ubuntu release.

[greptile-apps]

Unclosed <div> tag

The <div align="center"> opened on line 1 is never closed. While this file appears to be a WIP draft, an unclosed <div> will cause all subsequent content to be center-aligned when rendered on GitHub, which is likely unintended for the Features/Hardware/Installation sections.