Skip to content

chore: document agent guidelines and sync bun lock#3

Merged
anubissbe merged 2 commits intomainfrom
feat/docker-server
Oct 26, 2025
Merged

chore: document agent guidelines and sync bun lock#3
anubissbe merged 2 commits intomainfrom
feat/docker-server

Conversation

@anubissbe
Copy link
Owner

@anubissbe anubissbe commented Oct 26, 2025

Summary

  • add AGENTS.md so repo guidelines are discoverable by agent workflows
  • sync bun.lock to reflect dashboard-web workspace dependencies and updated bun types

Testing

  • Not run (not requested)

Summary by Sourcery

Add repository guidelines for agents, introduce a production-ready Dockerfile with corresponding docs updates, and sync the bun.lock file to match current workspace dependencies.

New Features:

  • Add AGENTS.md with repository guidelines for agent workflows.

Enhancements:

  • Provide a production-ready Dockerfile and .dockerignore for containerized deployment.

Documentation:

  • Update deployment and README documentation with Docker build, run, and Compose instructions.

Chores:

  • Synchronize bun.lock to reflect updated workspace dependencies and Bun type changes.

@sourcery-ai
Copy link

sourcery-ai bot commented Oct 26, 2025

Reviewer's Guide

This PR introduces a dedicated AGENTS.md for repository guidelines, adds a production-ready multi-stage Dockerfile, updates deployment documentation and README to leverage the new Docker workflow, and syncs the Bun lockfile to reflect updated workspace dependencies and types.

Class diagram for AGENTS.md repository structure documentation

classDiagram
  class Apps {
    +server
    +tui
    +lander
  }
  class Packages {
    +core
    +core-di
    +load-balancer
    +http-api
    +proxy
    +database
    +dashboard-web
    +ui-common
    +ui-constants
    +agents
    +cli-commands
  }
  class Docs {
    +deployment.md
    +AGENTS.md
  }
  class Configs {
    +tsconfig.json
    +biome.json
  }
  Apps --|> Packages
  Docs --|> Apps
  Docs --|> Packages
  Configs --|> Apps
  Configs --|> Packages
Loading

File-Level Changes

Change Details Files
Add comprehensive agent guidelines
  • Create AGENTS.md with sections on project structure, build/dev commands, coding style, testing, commit/PR guidelines, and security tips
AGENTS.md
Sync Bun lockfile
  • Regenerate bun.lock to align Bun version, dependencies, and updated type definitions
bun.lock
Introduce production-ready multi-stage Dockerfile
  • Build dashboard assets in a builder stage
  • Install runtime dependencies and curl for health checks
  • Configure volumes, expose port, define healthcheck and entrypoint
Dockerfile
Refactor deployment documentation for Docker
  • Replace inline Dockerfile example with docker build/run snippets
  • Simplify Docker Compose env and volume configuration
  • Add runtime configuration tips and healthcheck notes
docs/deployment.md
Augment README with Docker usage
  • Add build and run commands for Docker
  • Explain volume mapping for config and database persistence
  • Link to detailed deployment documentation
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@anubissbe anubissbe merged commit 81728dd into main Oct 26, 2025
1 check 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