docs: add community registry and widget deployment documentation#4
Merged
Conversation
Add comprehensive documentation for the YAML-driven community registry: - Registry overview with architecture diagram - Quick-start tutorial for adding new communities - Full YAML schema reference with validation rules - Extensions guide for Python plugins and MCP servers - Widget deployment guide with all configuration options Update mkdocs.yml navigation and OSA index page. Closes OpenScience-Collective/osa#49
2 tasks
- Fix plugin discovery docs: uses __all__ exports, not @tool scanning - Fix widget markdown claims: no syntax highlighting or strikethrough - Add source_repo field to DocSource schema reference table - Fix widget API response: tool_calls not session_id - Add note about cf_turnstile_response handled by Worker proxy - Add missing widget config options: repoUrl, repoName, pageContext* - Fix communityId validation description to match actual regex - Fix extensions loading order to match actual init sequence
Member
Author
PR Review Findings - AddressedReview ran with comment-analyzer and code-reviewer agents. All critical and important issues fixed in commit 11f84ca. Critical (Fixed)
Important (Fixed)
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
New Documentation
Community Registry (
docs/osa/registry/)Deployment (
docs/osa/deployment/)Related
Closes OpenScience-Collective/osa#49 (Phase 6: Documentation for YAML registry system)
Test plan