Skip to content

docs: update developer docs for the cheetahclaws package layout#148

Merged
chauncygu merged 1 commit into
mainfrom
fix/ci-package-smoke
Jun 16, 2026
Merged

docs: update developer docs for the cheetahclaws package layout#148
chauncygu merged 1 commit into
mainfrom
fix/ci-package-smoke

Conversation

@chauncygu

Copy link
Copy Markdown
Contributor

After the package move, the entry file is cheetahclaws/cli.py (not cheetahclaws.py) and module sources live under cheetahclaws/. Update the three current developer-facing docs:

  • cheetahclaws.py -> cheetahclaws/cli.py in prose (architecture.md, contributor_guide.md)
  • python cheetahclaws.py -> python -m cheetahclaws in usage (reference.md) — running cli.py directly no longer works (absolute imports need the package on sys.path)
  • fix ~40 broken relative module links in architecture.md (](../config.py) -> ](../cheetahclaws/config.py), etc.); all rewritten targets verified to exist

Historical docs (RFCs, i18n READMEs, PR notes) intentionally left as-is.

After the package move, the entry file is cheetahclaws/cli.py (not
cheetahclaws.py) and module sources live under cheetahclaws/. Update the
three current developer-facing docs:

- cheetahclaws.py -> cheetahclaws/cli.py in prose (architecture.md,
  contributor_guide.md)
- `python cheetahclaws.py` -> `python -m cheetahclaws` in usage
  (reference.md) — running cli.py directly no longer works (absolute
  imports need the package on sys.path)
- fix ~40 broken relative module links in architecture.md
  (](../config.py) -> ](../cheetahclaws/config.py), etc.); all rewritten
  targets verified to exist

Historical docs (RFCs, i18n READMEs, PR notes) intentionally left as-is.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@chauncygu chauncygu merged commit 22b9315 into main Jun 16, 2026
6 checks passed
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