chore(docs): reorganize docs/ tree + rename clawspring → cheetahclaws…#117
Merged
Conversation
… in asset refs
Two coupled cleanups:
1. Reorganize docs/ tree. The top level had 50+ files mixed: demo gifs,
logos, README localizations, comparison docs, and stub leftovers.
New layout groups by kind:
docs/
├── README.md (new — index page)
├── news.md, agent-os.md, architecture.md, contributor_guide.md
├── guides/, RFC/, roadmap/, superpowers/, PR/ (unchanged)
├── media/
│ ├── demos/ (21 *_demo.gif moved here)
│ ├── logos/ (7 logo-*.png moved here)
│ └── screenshots/ (screenshot.png moved here)
├── i18n/ (7 README.<lang>.MD moved here)
└── archive/ (3 superseded docs: update_readme_v3.0.md +
2 comparison files vs v3.03)
Stubs removed: docs/readme.md (5 bytes, content "cheetahclaws demo")
and docs/update_readme_v3.02.md (1 byte, empty).
All moves use git mv so history is preserved.
2. Switch GitHub-absolute asset URLs to relative paths + fix lingering
'clawspring' (the project's old name) references.
Two transformations across README.md + every doc:
(A) Asset URLs (gif/png/md under docs/) on either repo name converted
to file-relative paths. Survives rename and fork, works in local
clones / IDE previews, and GitHub still renders them correctly.
https://github.com/SafeRL-Lab/clawspring/blob/main/docs/web_demo.gif
↓
docs/media/demos/web_demo.gif (from README.md)
../media/demos/web_demo.gif (from docs/guides/*.md)
(B) Non-asset clawspring URLs (issues, DeepWiki, repo home) renamed
to cheetahclaws but kept absolute — they're cross-repo
identifiers, relative paths don't apply.
Tally across 16 modified files: 0 broken refs after the pass,
0 lingering 'clawspring' references outside docs/archive/.
Tests: pre-existing suites unaffected (32/32 web_api, all green).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
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.
… in asset refs
Two coupled cleanups:
Reorganize docs/ tree. The top level had 50+ files mixed: demo gifs, logos, README localizations, comparison docs, and stub leftovers. New layout groups by kind:
docs/
├── README.md (new — index page)
├── news.md, agent-os.md, architecture.md, contributor_guide.md
├── guides/, RFC/, roadmap/, superpowers/, PR/ (unchanged)
├── media/
│ ├── demos/ (21 _demo.gif moved here)
│ ├── logos/ (7 logo-.png moved here)
│ └── screenshots/ (screenshot.png moved here)
├── i18n/ (7 README..MD moved here)
└── archive/ (3 superseded docs: update_readme_v3.0.md +
2 comparison files vs v3.03)
Stubs removed: docs/readme.md (5 bytes, content "cheetahclaws demo") and docs/update_readme_v3.02.md (1 byte, empty).
All moves use git mv so history is preserved.
Switch GitHub-absolute asset URLs to relative paths + fix lingering 'clawspring' (the project's old name) references.
Two transformations across README.md + every doc:
(A) Asset URLs (gif/png/md under docs/) on either repo name converted
to file-relative paths. Survives rename and fork, works in local
clones / IDE previews, and GitHub still renders them correctly.
(B) Non-asset clawspring URLs (issues, DeepWiki, repo home) renamed
to cheetahclaws but kept absolute — they're cross-repo
identifiers, relative paths don't apply.
Tally across 16 modified files: 0 broken refs after the pass, 0 lingering 'clawspring' references outside docs/archive/.
Tests: pre-existing suites unaffected (32/32 web_api, all green).