codex - 💡(How to fix) Fix Clarify thread/read vs thread/resume semantics in integration docs [1 comments, 2 participants]

TL;DR

Update the documentation to clearly distinguish between thread/read for state/history inspection and thread/resume for resuming an existing thread and subscribing to live updates.

Guidance

• Review the suggested documentation changes to ensure they accurately reflect the semantic difference between thread/read and thread/resume.
• Verify that the updated documentation explicitly states the purpose of each operation, including that thread/read is not a subscription primitive.
• Check the relevant source comments in codex-rs/app-server/src/thread_state.rs and codex-rs/tui/src/app.rs to ensure consistency with the updated documentation.
• Consider adding examples or use cases to the documentation to illustrate the correct usage of thread/read and thread/resume.

Example

No code snippet is provided as the issue is related to documentation and not a specific code implementation.

Notes

The suggested documentation changes aim to prevent integrators from building reconnect flows that lose important notifications. However, it is essential to review the updated documentation carefully to ensure it accurately reflects the intended behavior.

Recommendation

Apply the suggested documentation changes to clearly distinguish between thread/read and thread/resume, as this will help prevent misunderstandings and incorrect usage of these operations.