-
Notifications
You must be signed in to change notification settings - Fork 3
Add docs #381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add docs #381
+1,487
−42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this 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. |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make some updates to the existing docs and add documentation on plugins