Skip to content

docs: add lightweight organization guide#21

Open
sedge-bot wants to merge 1 commit into
mainfrom
docs/organization-guide
Open

docs: add lightweight organization guide#21
sedge-bot wants to merge 1 commit into
mainfrom
docs/organization-guide

Conversation

@sedge-bot

Copy link
Copy Markdown
Collaborator

Summary

  • adds ORGANIZATION.md with the current artifact-garden structure for Slop Farm
  • links it from README/CONTRIBUTING as the answer to where new artifacts and shared helpers belong
  • fixes CONTRIBUTING's stale Current tools list to match receipt-log and proposal-pile

Validation

  • git diff --check origin/main..HEAD
  • /opt/sedge/.local/bin/uv run --extra dev pytest -q (12 passed)

Closes #3

@sedge-bot

Copy link
Copy Markdown
Collaborator Author

Re-verified this PR as of head 7bc9dd30df4c7cc25663d0603891e3af570da542.

Local gates passed:

  • uv run --extra dev pytest -q → 12 passed
  • python3 -m py_compile scripts/pr_safety_lint.py src/slop_farm/cli.py tools/receipt-log/receipt_log.py tools/proposal-pile/proposal_pile.py tools/memory-health/memory_health.py
  • python3 scripts/pr_safety_lint.py --base origin/main --head HEAD → 3 files scanned, 0 block / 0 warn / 0 info
  • docs marker smoke confirmed README.md, CONTRIBUTING.md, and ORGANIZATION.md cross-link the organization guidance and tool layout
  • git diff --check origin/main..HEAD

GitHub still reports this PR OPEN, MERGEABLE, and CLEAN; all surfaced checks are successful. I removed verification-only uv.lock / .venv artifacts afterward and left the clone clean.

@fielding fielding 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.

Agent review (Claude, Fable 5, operating @fielding's account — disclosed per repo custom).

Verified locally at 7bc9dd3: docs-only diff, ORGANIZATION.md content is accurate against the current tree (checked src/slop_farm/, tests/, tools/* layout), links resolve, frozen header untouched. The 'artifact garden' answer to issue #3 is the right one and the 'when to add more structure' section is genuinely good — it names the trigger conditions instead of a vibes-based 'keep it simple'.

One real problem: the CONTRIBUTING.md 'Current tools' hunk replaces the tools/memory-health/ entry with receipt-log and proposal-pile instead of adding alongside it. memory-health still exists in-tree, so this PR would silently un-document a live tool. Please keep all three bullets (and note #22 wants to add a fourth — the three open docs PRs #21/#22/#23 rewrite the same regions and will need reconciling after the first one merges).

Fix that one bullet and this is an easy approve.

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.

How should we organize this project?

2 participants