Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@aknysh
Copy link
Member

@aknysh aknysh commented Nov 12, 2020

what

  • Update to support reference architectures

why

  • Rename opsctl to atmos
  • Rename projects/ to components/
  • Add vendor CLI for synching reference architecture components
  • Add terraform-backend CLI to generate Terraform S3 backends for Terraform components

@aknysh aknysh requested a review from osterman November 12, 2020 17:08
@aknysh aknysh requested a review from a team as a code owner November 12, 2020 17:08
@aknysh aknysh self-assigned this Nov 12, 2020
@aknysh aknysh merged commit 2f876cc into master Nov 12, 2020
@aknysh aknysh deleted the update-for-reference-architectures branch November 12, 2020 19:11
osterman added a commit that referenced this pull request Oct 6, 2025
Update developer and PRD documentation to reflect the new structured markdown
error formatting with explanations and examples.

## Changes

### Developer Guide (docs/errors.md)

**Error Builder API**:
- Document `WithExplanation()` and `WithExplanationf()` methods
- Document `WithExample()` and `WithExampleFile()` methods
- Add embedded markdown example pattern with `//go:embed`
- Update Quick Start with complete example using all features

**Error Formatting**:
- Add "Structured Markdown Output" section showing 6 sections
- Document section order and conditional rendering
- Provide complete example with all sections
- Update configuration options to reflect context table in all modes

### PRD (docs/prd/atmos-error-handling.md)

**Design Decisions**:
- Update "Builder Pattern for Complex Errors" with new methods
- Add "Structured Markdown Error Presentation" as Decision #5
- Document section hierarchy and visual design rationale
- Provide formatted example output

**Error Categories**:
- Update "Builder-Enhanced Errors" with rich error example
- Show explanations, examples, hints, and context together
- Document use cases for structured error presentation

**Migration Path**:
- Add Phase 6: Structured Markdown Error Formatting (Complete)
- Document all implementation details:
  - New builder methods
  - Formatter refactoring with 6 sections
  - Workflow error conversions
  - Exit code handling updates
  - 21 comprehensive tests
  - Golden snapshot regeneration

All documentation now reflects the complete structured markdown error system.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
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.

3 participants