Update README and improve agent skill documentation#168
Merged
Conversation
af4bb4c to
00af7ac
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces substantial improvements to project documentation and build tooling, focusing on clarifying architecture, conventions, and workflows for the
wherehouseCLI 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.mdto provide a concise, modernized list of build, test, and VCS commands, emphasizingmiseandjjusage.Build and Release Automation:
.mise/tasks/release_notesto.mise/tasks/pre-releaseand extended it to update pinned Nix version references inREADME.md, improving release consistency. Updated.goreleaser.ymlto use the new pre-release task. [1] [2] [3]Code Style, Conventions, and Open TODOs:
.serena/memories/code_style_and_conventions.mdto 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:
CLAUDE.mdwith sections on agent skills, GitHub issue tracker integration, triage label vocabulary, and domain documentation practices.Permissions and Settings:
.claude/settings.local.jsonto 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.