Skip to content

Update docs and changelog#4

Merged
xprilion merged 1 commit into
mainfrom
dev
Apr 26, 2026
Merged

Update docs and changelog#4
xprilion merged 1 commit into
mainfrom
dev

Conversation

@xprilion
Copy link
Copy Markdown
Owner

This pull request focuses on updating documentation and clarifying the architecture, configuration, and usage of OpenMLR. The changes modernize the README, improve the agent harness documentation, update API references, and correct the project version. These updates enhance clarity for both new and existing users, and ensure the documentation reflects recent feature and mode changes.

Documentation and Usage Updates:

  • README.md: Major rewrite for clarity—streamlined introduction, updated feature list, improved quick start and configuration sections, added testing instructions, and simplified Makefile usage. The onboarding flow and per-conversation parallelism are now highlighted. [1] [2] [3]
  • site/docs/agent-harness.md: Heavily revised to clarify the agent harness architecture, agent loop, mode enforcement, context management, doom loop detection, DB-persisted writing, Redis interrupt relay, sub-agent streaming, and per-conversation isolation. Outdated extension and debugging sections were removed. [1] [2]
  • site/docs/api.md: Updated API documentation to match current endpoints and features, clarified mode names (Plan/Execute), documented Redis interrupt relay, and added frontend route descriptions. Version in health endpoint updated. [1] [2] [3]
  • site/docs/.vitepress/config.ts: Navigation updated for new mode names (Plan/Execute), and a Changelog link was added. [1] [2]

Project Metadata:

@github-actions
Copy link
Copy Markdown

Qodana for Python

154 new problems were found

Inspection name Severity Problems
Invalid type hints definitions and usages 🔴 Failure 18
Invalid type hints definitions and usages 🔶 Warning 20
Unused imports 🔶 Warning 11
Unused local symbols ◽️ Notice 45
Class has no init method ◽️ Notice 39
Shadowing names from outer scopes ◽️ Notice 8
Accessing a protected member of a class or a module ◽️ Notice 6
Method is not declared static ◽️ Notice 3
PEP 8 naming convention violation ◽️ Notice 3
Inconsistent return statements ◽️ Notice 1

☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

@xprilion xprilion merged commit 495f322 into main Apr 26, 2026
5 checks passed
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.

1 participant