Skip to content

Docs: Create documentation for the Greenshot plugin#463

Merged
DotDev262 merged 1 commit into
DotDev262:mainfrom
rj9884:docs-greenshot-plugin
Jun 20, 2026
Merged

Docs: Create documentation for the Greenshot plugin#463
DotDev262 merged 1 commit into
DotDev262:mainfrom
rj9884:docs-greenshot-plugin

Conversation

@rj9884

@rj9884 rj9884 commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Related Issue

Closes #448

Proposed Changes

  • Created comprehensive documentation file for the Greenshot plugin at docs/plugins/greenshot.md.
  • Added registration entry for the greenshot plugin to the "Automation, Productivity, and Desktop Utilities" table in docs/plugins/README.md.
  • Documented configuration format, INI section mapping (backslash-separated compound keys), common settings, and verified usage examples.

Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • 📖 Documentation
  • 🧪 Testing
  • 🛠️ Refactoring
  • 🚀 DevOps/CI

Screenshots / Logs (if applicable)

Verified configuration examples against the plugin parser engine (plugins/greenshot/src/plugin.py) using a python validation script:

Example 1 result: {'requestId': 'test-1', 'changed': True}
Example 2 result: {'requestId': 'test-2', 'changed': True}
Example 3 result: {'requestId': 'test-3', 'changed': True}
All examples successfully validated against the plugin engine!

Testing & Verification

  • I have run dotnet test and all 60+ cross-platform tests passed. (Verified plugin unit tests locally)
  • I have verified the changes on a Windows environment (if applicable).
  • I have added new unit tests to cover my changes.

GSSOC 2026 Checklist

  • I have read the Contribution Guidelines.
  • My code is formatted correctly (I have run dotnet format, uv tool run ruff format plugins/, and bun x prettier --write plugins/).
  • I have linked the PR to an approved issue.
  • I understand that a maintainer must apply the gssoc:approved label for this PR to count for points.

@github-actions github-actions Bot added level:beginner Beginner level task type:docs Documentation GSSOC GirlScript Summer of Code 2026 labels Jun 20, 2026

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

Clean Greenshot docs — standard template, POSIX newlines, scoped. Approved.

@DotDev262 DotDev262 merged commit 0106f87 into DotDev262:main Jun 20, 2026
48 checks passed
@DotDev262 DotDev262 added the gssoc:approved Approved for GSSOC points (Required) label Jun 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved Approved for GSSOC points (Required) GSSOC GirlScript Summer of Code 2026 level:beginner Beginner level task type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Document Greenshot config provider plugin

2 participants