Skip to content

Commit bef96fd

Browse files
authored
Add troubleshooting section to docs (#676)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed
1 parent 934efd9 commit bef96fd

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,16 @@ See [Getting Started](https://docs.codegen.com/introduction/getting-started) for
7979
from codegen import Codebase
8080
```
8181

82+
## Troubleshooting
83+
84+
Having issues? Here are some common problems and their solutions:
85+
86+
- **I'm hitting an UV error related to `[[ packages ]]`**: This means you're likely using an outdated version of UV. Try updating to the latest version with: `uv self update`.
87+
- **I'm hitting an error about `No module named 'codegen.sdk.extensions.utils'`**: The compiled cython extensions are out of sync. Update them with `uv sync --reinstall-package codegen`.
88+
- **I'm hitting a `RecursionError: maximum recursion depth exceeded` error while parsing my codebase**: If you are using python 3.12, try upgrading to 3.13. If you are already on 3.13, try upping the recursion limit with `sys.setrecursionlimit(10000)`.
89+
90+
If you run into additional issues not listed here, please [join our slack community](https://community.codegen.com) and we'll help you out!
91+
8292
## Resources
8393

8494
- [Docs](https://docs.codegen.com)

0 commit comments

Comments
 (0)