Add a technical manual, etc #3911
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| package_root = Path(__file__).parent.parent.parent | ||
| docs_map: dict[str, tuple[Path, str]] = { | ||
| "readme": (package_root / "README.md", "CoGames overview and documentation"), | ||
| "mission": (package_root / "MISSION.md", "Mission briefing for Machina VII Deployment"), | ||
| "technical_manual": (package_root / "TECHNICAL_MANUAL.md", "Technical manual for Cogames"), |
There was a problem hiding this comment.
The new docs command builds package_root = Path(__file__).parent.parent.parent and then points all documents to package_root / "README.md", MISSION.md, etc. In an installed wheel, __file__ lives at <venv>/site-packages/cogames/main.py, so this path climbs out of the package to the Python install root (e.g., /usr/local/lib/python3.12/README.md), tripping the subsequent exists() check and causing every cogames docs <name> invocation to fail with “Document file not found.” The lookup should stay within the installed package (e.g., Path(__file__).parent) or use package resources so the command works after installation.
Useful? React with 👍 / 👎.
Add a technical manual to cogames, and a
cogames docscommand.https://app.asana.com/1/1209016784099267/project/1209096222434381/task/1211456439686302?focus=true
https://app.asana.com/1/1209016784099267/project/1211340635624763/task/1211540177995104?focus=true
Asana Task