Skip to content

docs(openclaw-plugin): refresh architecture guides with diagrams#1145

Merged
Mijamind719 merged 1 commit intomainfrom
docs/openclaw-plugin-architecture-readme
Apr 1, 2026
Merged

docs(openclaw-plugin): refresh architecture guides with diagrams#1145
Mijamind719 merged 1 commit intomainfrom
docs/openclaw-plugin-architecture-readme

Conversation

@qin-ctx
Copy link
Copy Markdown
Collaborator

@qin-ctx qin-ctx commented Apr 1, 2026

Description

Refresh the OpenClaw plugin architecture guides so they describe the current implementation more clearly, and add diagram assets that explain the main runtime flows.

Related Issue

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Reworked examples/openclaw-plugin/README.md into an implementation-focused architecture guide for the current plugin behavior.
  • Reworked examples/openclaw-plugin/README_CN.md to match the same structure and clarify the current runtime, recall, session, and routing model.
  • Added four PNG diagrams for overall architecture, prompt-front recall flow, session lifecycle, and local/remote routing behavior.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Manual checks performed:

  • Ran git diff --check
  • Reviewed the generated PNG diagrams visually after layout adjustments

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

Added architecture screenshots directly under examples/openclaw-plugin/images/ and referenced them from both plugin READMEs.

Additional Notes

This PR intentionally keeps only the final PNG assets in the repository and does not include the temporary local generation helper used during drafting.

Reframe the OpenClaw plugin READMEs around the current runtime design and add architecture diagrams for recall, session lifecycle, and routing.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

Failed to generate code suggestions for PR

@Mijamind719 Mijamind719 merged commit 2bc65f3 into main Apr 1, 2026
2 checks passed
@Mijamind719 Mijamind719 deleted the docs/openclaw-plugin-architecture-readme branch April 1, 2026 07:31
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants