Skip to content

docs: add clear project integration guide for pipeworks_ipc#6

Merged
aa-parky merged 1 commit intomainfrom
codex/docs-project-integration-guide
Feb 22, 2026
Merged

docs: add clear project integration guide for pipeworks_ipc#6
aa-parky merged 1 commit intomainfrom
codex/docs-project-integration-guide

Conversation

@aa-parky
Copy link
Copy Markdown
Contributor

Summary

  • add a dedicated Sphinx page docs/source/project_integration.rst focused on real project adoption
  • document how to replace copied IPC hashing code with the shared pipeworks_ipc package
  • include a practical integration helper pattern, metadata persistence guidance, migration checklist, and deterministic test template
  • wire the new page into docs navigation via docs/source/index.rst
  • add a cross-link in docs/source/usage.rst to direct users to the integration guide

Validation

  • make -C docs clean html
  • pre-commit run --files docs/source/index.rst docs/source/usage.rst docs/source/project_integration.rst

Goal

This makes the docs explicit about why and how to consume pipeworks_ipc in downstream projects so IPC logic is reused instead of re-implemented.

@aa-parky aa-parky merged commit 50e0627 into main Feb 22, 2026
12 checks passed
@aa-parky aa-parky deleted the codex/docs-project-integration-guide branch February 22, 2026 11:40
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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