Skip to content

Chore/bisect#3

Open
danielbodnar wants to merge 19 commits intomainfrom
chore/bisect
Open

Chore/bisect#3
danielbodnar wants to merge 19 commits intomainfrom
chore/bisect

Conversation

@danielbodnar
Copy link
Contributor

@danielbodnar danielbodnar commented Oct 28, 2025

This pull request introduces several foundational improvements to the BitBuilder Cloud CLI (bbctl) project, focusing on documentation, configuration, code quality, and initial planning. The changes establish a clear project structure, add configuration and linting for both Rust and TypeScript development, and provide comprehensive guides and plans for future development.

Project Planning and Documentation:

  • Added a detailed implementation plan for bbctl, outlining architecture, phases, and directory structure in PLAN.md.
  • Introduced an API documentation guide using Zod and OpenAPI in docs/api-readme.md, including instructions for schema validation, type safety, and client generation.
  • Added a comprehensive configuration guide in docs/configuration-guide.md, covering all aspects of bbctl configuration, provider and credential management, and best practices.
  • Expanded the main README.md with instructions for testing against a VyOS lab environment.

Development Environment and Tooling:

  • Added .eslintrc.json for TypeScript linting with recommended rules and project-specific overrides.
  • Introduced bunfig.toml to configure Bun for dependency management, testing, and building TypeScript code.
  • Updated Cargo.toml to include the uuid crate for networking and security features, preparing for future API and RPC additions.

Developer Experience and Guidelines:

  • Enhanced CLAUDE.md with more detailed build, test, and style guidelines, including project structure, code formatting, and naming conventions. [1] [2] [3] [4]

These changes lay the groundwork for robust development practices, clear documentation, and a maintainable codebase as bbctl evolves.

Loading
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