Skip to content

docs: sharpen project documentation#9

Merged
machado144 merged 1 commit into
mainfrom
docs/sharpen-yoink-positioning
Jun 2, 2026
Merged

docs: sharpen project documentation#9
machado144 merged 1 commit into
mainfrom
docs/sharpen-yoink-positioning

Conversation

@machado144

Copy link
Copy Markdown
Contributor

Summary

  • tighten the README into a clearer landing page with positioning, quickstart, command summary, and doc links
  • add Why yoink? positioning docs with comparisons to tmux, expect, shell jobs, and process supervisors
  • add focused command reference and killer CI/automation examples

Validation

  • git diff --check

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

Invalid PR Title

PR title must follow the Conventional Commits format since we use squash merge:

<type>[optional scope][!]: <description>

Allowed types: feat, fix, docs, style, refactor, test, chore, build, ci, perf, revert

Examples:

  • feat: add new feature
  • fix(daemon): resolve socket cleanup issue
  • feat!: breaking change
  • chore(deps): update dependencies

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

StructLint — All checks passed

67 rules validated against .structlint.yaml. No violations found.

View full run · Powered by StructLint

@machado144 machado144 force-pushed the docs/sharpen-yoink-positioning branch from b08faf5 to 32e4573 Compare June 2, 2026 19:11
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

Invalid PR Title

PR title must follow the Conventional Commits format since we use squash merge:

<type>[optional scope][!]: <description>

Allowed types: feat, fix, docs, style, refactor, test, chore, build, ci, perf, revert

Examples:

  • feat: add new feature
  • fix(daemon): resolve socket cleanup issue
  • feat!: breaking change
  • chore(deps): update dependencies

@machado144 machado144 changed the title Sharpen docs positioning docs: sharpen project documentation Jun 2, 2026
@machado144 machado144 force-pushed the docs/sharpen-yoink-positioning branch from 32e4573 to 89958fd Compare June 2, 2026 19:14
@machado144 machado144 force-pushed the docs/sharpen-yoink-positioning branch from 89958fd to e3864c8 Compare June 2, 2026 19:16
@machado144 machado144 merged commit e73b6bf into main Jun 2, 2026
5 checks passed
@machado144 machado144 deleted the docs/sharpen-yoink-positioning branch June 2, 2026 19:19
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