Skip to content

Fix documentation, URL defaults, and some UI issues#108

Merged
BeckettFrey merged 14 commits into
mainfrom
release
Apr 14, 2026
Merged

Fix documentation, URL defaults, and some UI issues#108
BeckettFrey merged 14 commits into
mainfrom
release

Conversation

@BeckettFrey

Copy link
Copy Markdown
Member

This pull request makes significant changes to the project's developer workflow, build configuration, and documentation. The main focus is on replacing Makefile-based commands with invoke for all developer and CI tasks, removing the legacy Makefile, updating pre-commit and code quality tooling, and improving onboarding and documentation for contributors and agents.

Developer Workflow Modernization:

  • Switched all developer, CI, and code quality commands from make/Makefile to invoke task runner: This includes updating documentation, agent guides, and all GitHub Actions workflows to use invoke commands (e.g., invoke lint, invoke run-tests) instead of Makefile targets. The Makefile is removed entirely. (.github/agents/code-quality.agent.md [1] [2]; .github/workflows/code-quality.yml [3] [4] [5]; .github/workflows/tests-macos.yml [6]; .github/workflows/tests-ubuntu.yml [7]; .github/workflows/tests-windows.yml [8]; README.md [9]; Makefile [10]

Build and Release Process:

  • Removed the release.yml GitHub Actions workflow: This eliminates the automated macOS build and release process, including all steps for building, packaging, and uploading release artifacts. (.github/workflows/release.yml .github/workflows/release.ymlL1-L125)

Pre-commit and Code Quality Tooling:

  • Updated pre-commit configuration: Added a local shredguard check, switched the mypy hook to a local configuration using uv run, and removed the previous remote mypy mirror. (.pre-commit-config.yaml .pre-commit-config.yamlR2-R24)

Documentation and Onboarding Improvements:

  • Added a comprehensive AGENTS.md onboarding guide: This file explains project structure, architecture, code standards, testing, and common pitfalls for coding agents and contributors. (AGENTS.md AGENTS.mdR1-R77)
  • Improved and clarified developer documentation: Updated the README.md to reflect the new invoke-based workflow, revised prerequisites, added a ShredGuard badge, and clarified instructions for new contributors. (README.md [1] [2] [3] [4]

Configuration:

  • Added logging configuration to config/app_info.yaml: Introduced parameters for log file size and rotation. (config/app_info.yaml config/app_info.yamlR9-R12)

These changes collectively modernize and simplify the development workflow, improve code quality tooling, and enhance onboarding for new contributors.

BeckettFrey and others added 14 commits April 13, 2026 15:05
* Initial plan

* fix: replace localhost help_url defaults with production URL

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/496f7ed1-fdaa-4df9-b574-5ab55254c136

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
)

* Initial plan

* fix: prevent helper_label and empty_label from resizing with splitter

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/ede8fa76-ccf4-4940-bd76-7f46adde44c5

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
* refactor: remove shadowed config

* replace: move to invoke for os agnostic clarity

* remove release workflow in favor of more manual steps
* Initial plan

* fix: don't mark first launch complete on startup script error

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/e51a7557-a81e-4972-a7e6-45133b115413

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
…e_id (#101)

* Initial plan

* fix: handle prefixed IDs in readable_from_unique_id

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/f6936450-f9a2-4df8-b75a-b403d98db565

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

* fix: raise descriptive ValueError when no timestamp found in readable_from_unique_id

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/f6936450-f9a2-4df8-b75a-b403d98db565

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
…ls directory (#100)

* Initial plan

* fix: add empty-ID guard to delete_model to prevent wiping engine models directory

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/0cce5a70-83a5-4c00-b1e8-19f85cb895d1

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
…l files (#102)

* Initial plan

* fix: validate_dataset checks stem-name pairing between audio and label files

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/73d34692-65d9-48a2-9621-7127982837a2

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

* chore: remove accidentally committed root conftest.py

Agent-Logs-Url: https://github.com/BrainBehaviorAnalyticsLab/voxkit-desktop/sessions/46f1cfe0-1564-47a8-85ea-4c404b6b23f8

Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BeckettFrey <83560790+BeckettFrey@users.noreply.github.com>
* Fix button width inconsistency

* Migrate to table style
@BeckettFrey BeckettFrey merged commit 2941a78 into main Apr 14, 2026
7 of 9 checks passed
@BeckettFrey BeckettFrey deleted the release branch April 14, 2026 22:49
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.

2 participants