Files
Medios-Macina/docs/PR_PROVIDER_AUTHORING.md
T
2026-05-16 15:26:08 -07:00

712 B

PR Title: docs: Add plugin authoring doc, examples, and tests

Summary:

  • Add docs/provider_authoring.md describing the strict ResultModel-based plugin adapter pattern, ColumnSpec usage, selection_fn, and TableProviderMixin for HTML table scraping.
  • Link the new doc from docs/result_table.md.
  • Add tests/test_provider_author_examples.py to validate the example plugin integration with the registry.

Why:

  • Provide a short, focused Quick Start to help contributors author plugins that integrate with the strict ResultTable API.

Testing:

  • New tests pass locally (plugin-related subset).

Notes:

  • The change is documentation-first and non-functional, with tests ensuring examples remain valid.