Skip to content

Update README and improve agent skill documentation#168

Merged
asphaltbuffet merged 4 commits into
mainfrom
doc-updates
May 28, 2026
Merged

Update README and improve agent skill documentation#168
asphaltbuffet merged 4 commits into
mainfrom
doc-updates

Conversation

@asphaltbuffet
Copy link
Copy Markdown
Owner

This pull request introduces substantial improvements to project documentation and build tooling, focusing on clarifying architecture, conventions, and workflows for the wherehouse CLI inventory system. It adds new and reorganized documentation files covering the domain model, technical stack, conventions, and development practices. The build process is streamlined by enhancing the pre-release automation. Several code style and convention documents are updated for accuracy, and open TODOs are tracked for future improvements.

Documentation and Project Structure:

  • Added new documentation files: CONTEXT.md (domain model and glossary), .serena/memories/core.md (layered architecture), .serena/memories/tech_stack.md (technology stack), .serena/memories/conventions.md (code and workflow conventions), .serena/memories/task_completion.md (commit checklist), and updated .serena/memories/project_overview.md (file/package structure and responsibilities). [1] [2] [3] [4] [5] [6]

  • Updated .serena/memories/suggested_commands.md to provide a concise, modernized list of build, test, and VCS commands, emphasizing mise and jj usage.

Build and Release Automation:

  • Renamed .mise/tasks/release_notes to .mise/tasks/pre-release and extended it to update pinned Nix version references in README.md, improving release consistency. Updated .goreleaser.yml to use the new pre-release task. [1] [2] [3]

Code Style, Conventions, and Open TODOs:

  • Refined .serena/memories/code_style_and_conventions.md to clarify interface usage, event type registration, error handling, and database practices. Added a section for open TODOs from code review. [1] [2]

Agent and Issue Tracker Documentation:

  • Expanded CLAUDE.md with sections on agent skills, GitHub issue tracker integration, triage label vocabulary, and domain documentation practices.

Permissions and Settings:

  • Updated .claude/settings.local.json to enable additional plugins, including GitHub issue writing and memory management features.

These changes collectively improve onboarding, maintainability, and development efficiency by making the architecture, conventions, and workflows explicit and actionable.

@asphaltbuffet asphaltbuffet merged commit 39809ab into main May 28, 2026
6 checks passed
@asphaltbuffet asphaltbuffet deleted the doc-updates branch May 28, 2026 16:52
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