Skip to content

docs: make the capture path followable, and add LICENSE/NOTICE - #94

Merged
Wenzel merged 1 commit into
masterfrom
docs/capture-path-fixes
Aug 25, 2026
Merged

Wenzel merged 1 commit into
masterfrom
docs/capture-path-fixes

Conversation

@Wenzel

@Wenzel Wenzel commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

The tutorial and the system-deps guide both sent readers to "the docker-compose
stack shipped with neogit". No such stack exists, in the tree or anywhere in
neogit's history. Both now use a single docker run for Neo4j, which is all a
first capture needs: neogit defaults to local-filesystem object storage, so
MinIO is optional and the tutorial's MINIO_* secrets were never required.
oswatcher-deploy is named as the full-stack option rather than the starting
point.

poetry install also could not succeed on a machine prepared by our own apt
line. guestfs and libvirt-python are C extensions built from source, so the
install died at fatal error: guestfs.h: No such file or directory. Adds the
build headers and a note explaining they are headers, not runtime tools.
Verified in a clean ubuntu:24.04 container: guestfs and libvirt-python both
compile and import.

Also adds the Apache 2.0 LICENSE and NOTICE the README badge already pointed
at, expands the README and docs index with the pipeline diagram and a
tutorial-first entry point, and marks the finished items in
OPEN_SOURCE_TASKS.md.

Docs build clean with -W.

Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01FNgjQ6o613ULuMRGhLnyUU

The tutorial and the system-deps guide both sent readers to "the docker-compose
stack shipped with neogit". No such stack exists, in the tree or anywhere in
neogit's history. Both now use a single `docker run` for Neo4j, which is all a
first capture needs: neogit defaults to local-filesystem object storage, so
MinIO is optional and the tutorial's MINIO_* secrets were never required.
oswatcher-deploy is named as the full-stack option rather than the starting
point.

`poetry install` also could not succeed on a machine prepared by our own apt
line. `guestfs` and `libvirt-python` are C extensions built from source, so the
install died at `fatal error: guestfs.h: No such file or directory`. Adds the
build headers and a note explaining they are headers, not runtime tools.
Verified in a clean ubuntu:24.04 container: guestfs and libvirt-python both
compile and import.

Also adds the Apache 2.0 LICENSE and NOTICE the README badge already pointed
at, expands the README and docs index with the pipeline diagram and a
tutorial-first entry point, and marks the finished items in
OPEN_SOURCE_TASKS.md.

Docs build clean with -W.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FNgjQ6o613ULuMRGhLnyUU
@Wenzel
Wenzel merged commit 674ae01 into master Aug 25, 2026
7 checks passed
@Wenzel
Wenzel deleted the docs/capture-path-fixes branch August 25, 2026 01:16
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.

1 participant