Skip to content

docs: add community registry and widget deployment documentation#4

Merged
neuromechanist merged 2 commits into
mainfrom
feature/issue-49-registry-docs
Jan 24, 2026
Merged

docs: add community registry and widget deployment documentation#4
neuromechanist merged 2 commits into
mainfrom
feature/issue-49-registry-docs

Conversation

@neuromechanist

Copy link
Copy Markdown
Member

Summary

  • Add comprehensive community registry documentation (YAML-driven assistant configuration)
  • Add widget deployment guide with all configuration options
  • Update navigation and OSA index page

New Documentation

Community Registry (docs/osa/registry/)

  • Overview - How the registry works, directory structure, key principles
  • Quick Start - Step-by-step tutorial for adding a new community assistant
  • Schema Reference - Full YAML config reference with all fields, types, and validation rules
  • Extensions - Python plugin and MCP server extension guide

Deployment (docs/osa/deployment/)

  • Widget - Embeddable chat widget configuration, features, and troubleshooting

Related

Closes OpenScience-Collective/osa#49 (Phase 6: Documentation for YAML registry system)

Test plan

  • Verify all new pages render correctly in mkdocs
  • Check all internal links resolve
  • Confirm nav structure matches issue requirements

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
- 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
@neuromechanist

Copy link
Copy Markdown
Member Author

PR Review Findings - Addressed

Review ran with comment-analyzer and code-reviewer agents. All critical and important issues fixed in commit 11f84ca.

Critical (Fixed)

  • Plugin discovery docs incorrect: Claimed @tool scanning; actually uses __all__ exports
  • Widget markdown claims: Removed false claims of syntax highlighting and strikethrough
  • Missing source_repo field: Added to DocSource schema reference table
  • Widget API response format: Fixed from session_id to tool_calls (matching AskResponse model)

Important (Fixed)

  • cf_turnstile_response: Added note that it's consumed by Worker proxy, not backend
  • Missing widget config options: Added repoUrl, repoName, pageContextStorageKey, pageContextLabel
  • communityId validation: Updated troubleshooting to match actual regex (accepts uppercase and underscores)
  • Extensions loading order: Corrected to match actual init sequence in CommunityAssistant

@neuromechanist
neuromechanist merged commit a670fc9 into main Jan 24, 2026
@neuromechanist
neuromechanist deleted the feature/issue-49-registry-docs branch January 24, 2026 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Phase 6: Documentation for YAML registry system

1 participant