doc: update development.md with troubleshooting section - #17
Conversation
add common troubleshoot to development md
michaelegner
left a comment
There was a problem hiding this comment.
Thanks for the contribution — this covers the scope of issue #2 well and the troubleshooting section is useful.
I only have one wording correction before merge: in the Docker Compose case, the app already waits for Neo4j via depends_on: condition: service_healthy, so the text should not imply that the app commonly starts before Neo4j is ready. That race is mainly relevant when running the app directly with uvicorn.
Please adjust the Neo4j startup and /api/import troubleshooting sections to distinguish:
Docker Compose: app waits for Neo4j health
direct/local run: Neo4j may still be unavailable when the app starts
Optionally, it would also be helpful to mention that changing NEO4J_PASSWORD in .env does not update credentials in an already-initialized Neo4j data volume.
Once that wording is updated and CI/CodeQL have run successfully, this should be ready to merge.
|
Please make these final documentation adjustments:
|
|
Hi @michaelegner thank you for the feedback! I've updated with your instructions. Please let me know if any further update is needed. |
michaelegner
left a comment
There was a problem hiding this comment.
Thanks Florian, all requested documentation corrections are implemented accurately!
What does this change?
Closes #2
Checklist
THIRD_PARTY_LICENSES.md)If this adds or changes an adapter
tests/fixtures/and/orexamples/)docs/adapter-development.mdand/or the relevantdocs/*.md)