Skip to content

Conversation

@ppinchuk
Copy link
Collaborator

Make some updates to the existing docs and add documentation on plugins

@ppinchuk ppinchuk self-assigned this Feb 12, 2026
@ppinchuk ppinchuk requested a review from castelao as a code owner February 12, 2026 07:14
Copilot AI review requested due to automatic review settings February 12, 2026 07:14
@ppinchuk ppinchuk added documentation Improvements or additions to documentation enhancement Update to logic or general code improvements topic-python-general Issues/pull requests related to python p-high Priority: high labels Feb 12, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates and expands COMPASS documentation, including new developer-facing tutorials on plugin development and improvements to one-shot plugin example documentation/configs.

Changes:

  • Add new developer docs pages for plugin development (basic + advanced) and link them from the dev docs index.
  • Improve one-shot schema extraction example documentation and reformat YAML plugin config prompts for readability.
  • Update Sphinx config to suppress highlighting warnings and add documentation-writing guidance to Copilot instructions.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
examples/parse_existing_docs/CLI/README.rst Clarifies jurisdiction-code mapping and links to known jurisdictions list.
examples/one_shot_schema_extraction/plugin_config.yaml Reformats prompts into YAML block scalars and updates extraction system prompt formatting.
examples/one_shot_schema_extraction/README.rst Expands guidance on schema customization and qualitative outputs; tweaks schema example snippet.
docs/source/dev/plugin_development.rst Adds a step-by-step plugin development tutorial (battery storage example).
docs/source/dev/index.rst Adds a toctree for dev docs navigation.
docs/source/dev/advanced_plugin_development.rst Adds a comprehensive advanced plugin development guide (hooks, BaseExtractionPlugin, RAG, custom outputs).
docs/source/conf.py Adds suppression for Sphinx highlighting-failure warnings.
.github/copilot-instructions.md Adds guidance on documentation voice for tutorials/READMEs.

@ppinchuk ppinchuk merged commit 3cb392e into main Feb 12, 2026
5 checks passed
@ppinchuk ppinchuk deleted the pp/minor_docs branch February 12, 2026 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement Update to logic or general code improvements p-high Priority: high topic-python-general Issues/pull requests related to python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant