Skip to content

doc: update development.md with troubleshooting section - #17

Merged
michaelegner merged 5 commits into
michaelegner:mainfrom
beranekjr:issue-2
Sep 4, 2026
Merged

doc: update development.md with troubleshooting section#17
michaelegner merged 5 commits into
michaelegner:mainfrom
beranekjr:issue-2

Conversation

@beranekjr

@beranekjr beranekjr commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

What does this change?

Closes #2

Checklist

  • tests added/updated
  • documentation updated
  • no secrets included
  • licensing compatible (new dependencies are Apache-2.0-compatible; see THIRD_PARTY_LICENSES.md)
  • backwards compatibility considered

If this adds or changes an adapter

  • unit tests
  • integration fixture (tests/fixtures/ and/or examples/)
  • adapter documentation (docs/adapter-development.md and/or the relevant docs/*.md)

@michaelegner michaelegner left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

michaelegner commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Please make these final documentation adjustments:

  • State that Docker Compose already blocks the app on depends_on: condition: service_healthy; the startup-order race applies to a direct uvicorn run.
  • Update the POST /api/import section accordingly: under Compose, inspect health, logs, and credentials; for a direct run, start Neo4j before the app.
  • Add the useful volume caveat: changing NEO4J_PASSWORD in .env does not change credentials in an already initialized neo4j-data volume. If suggesting docker compose down -v, explicitly warn that it deletes the local Compose volumes.

@beranekjr

Copy link
Copy Markdown
Contributor Author

Hi @michaelegner thank you for the feedback! I've updated with your instructions. Please let me know if any further update is needed.

@michaelegner michaelegner left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Florian, all requested documentation corrections are implemented accurately!

@michaelegner
michaelegner merged commit d9129af into michaelegner:main Sep 4, 2026
5 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.

Add a Troubleshooting section to docs/development.md

2 participants