Skip to content

v0.6.1 - #208

Merged
RyanTheRobothead merged 9 commits into
mainfrom
unstable
Jan 1, 2026
Merged

v0.6.1#208
RyanTheRobothead merged 9 commits into
mainfrom
unstable

Conversation

@RyanTheRobothead

Copy link
Copy Markdown
Member

PR Info

This pull request introduces several documentation and configuration improvements, as well as updates to development workflow files. The most significant changes are the addition of detailed API documentation for client modules, enhancements to environment variable documentation, and improvements to development tooling and automation.

Documentation Improvements:

  • Added comprehensive API documentation for the MadsciClientMixin and DataClient classes, detailing their usage, configuration options, and available methods and properties. [1] [2]

Configuration and Environment Variables:

  • Added new environment variables for service ports (REDIS_PORT, MONGODB_PORT, POSTGRES_PORT, MINIO_PORT, MINIO_CONSOLE_PORT) to .env.example and documented them in Configuration.md for improved clarity and configurability of local development environments. [1] [2]

Development Workflow and Tooling:

  • Introduced a new GitHub Actions workflow (gh_pages.yml) for automated documentation deployment to GitHub Pages, supporting both push and manual triggers.
  • Added a docs target to the .justfile for generating API documentation using pdoc.
  • Reorganized .pre-commit-config.yaml by moving the pre-commit-hooks repository block to the end of the file for better structure and maintainability. [1] [2]

Developer Checklists

I have:

  • Run Pre-commit and Unit Tests, and ensured that they pass
  • Created or updated documentation relevant to your change
  • Created or updated unit tests relevant to your change

@RyanTheRobothead RyanTheRobothead self-assigned this Jan 1, 2026
@RyanTheRobothead RyanTheRobothead added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jan 1, 2026
@RyanTheRobothead RyanTheRobothead added this to the 0.7 Release milestone Jan 1, 2026
@github-actions

github-actions Bot commented Jan 1, 2026

Copy link
Copy Markdown

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/madsci_data_manager/madsci/data_manager
  __init__.py
  src/madsci_event_manager/madsci/event_manager
  __init__.py
  src/madsci_experiment_application/madsci/experiment_application
  experiment_application.py 78, 80, 84, 86
  src/madsci_resource_manager/madsci/resource_manager
  __init__.py
Project Total  

This report was generated by python-coverage-comment-action

@RyanTheRobothead
RyanTheRobothead merged commit 46a96a2 into main Jan 1, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: Experiment Applications have no attribute experiment_client or workcell_client Any support needed for adding to readthedocs?

1 participant