Skip to content

chore(openspec): archive completed changes and align architecture docs#292

Merged
djm81 merged 3 commits intodevfrom
feature/arch-08-documentation-discrepancies-remediation
Feb 22, 2026
Merged

chore(openspec): archive completed changes and align architecture docs#292
djm81 merged 3 commits intodevfrom
feature/arch-08-documentation-discrepancies-remediation

Conversation

@djm81
Copy link
Copy Markdown
Collaborator

@djm81 djm81 commented Feb 22, 2026

Description

This PR combines the full requested workspace scope:

  • OpenSpec docs-remediation implementation for arch-08-documentation-discrepancies-remediation.
  • Archive + spec-sync operations completed for:
    • bundle-mapper-01-mapping-strategy
    • backlog-core-02-interactive-issue-creation
    • marketplace-01-central-module-registry
  • Architecture docs refactor and navigation improvements, including ADR docs and implementation-status docs.
  • README simplification to remove deep technical internals from top-level onboarding content.
  • Changelog and version files synced to latest dev baseline (0.36.0).

Fixes #291

New Features #121

Contract References: None added/modified in this PR (documentation + OpenSpec artifact updates only).

Type of Change

Please check all that apply:

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🔒 Contract enforcement (adding/updating @icontract decorators)
  • 🧪 Test enhancement (scenario tests, property-based tests)
  • 🔧 Refactoring (code improvement without functionality change)

Contract-First Testing Evidence

Required for all changes affecting CLI commands or public APIs:

Contract Validation

  • Runtime contracts added/updated (@icontract decorators on public APIs)
  • Type checking enforced (@beartype decorators applied)
  • CrossHair exploration completed: hatch run contract-test-exploration
  • Contract violations reviewed and addressed

Test Execution

  • Contract validation: hatch run contract-test-contracts
  • Contract exploration: hatch run contract-test-exploration
  • Scenario tests: hatch run contract-test-scenarios
  • Full test suite: hatch run contract-test-full

Test Quality

  • CLI commands tested with typer test client
  • Edge cases covered with Hypothesis property tests
  • Error handling tested with invalid inputs
  • Rich console output verified manually or with snapshots

How Has This Been Tested?

Contract-First Approach: OpenSpec validation and docs quality gates were run for changed artifacts. Full code contract test suite was not run in this pass.

Manual Testing

  • Tested CLI commands manually
  • Verified rich console output
  • Tested with different input scenarios
  • Checked error messages for clarity

Automated Testing

  • Contract validation passes
  • Property-based tests cover edge cases
  • Scenario tests cover user workflows
  • All existing tests still pass

Test Environment

  • Python version: 3.12 (Hatch default env)
  • OS: Linux

Checklist

  • My code follows the style guidelines (PEP 8, ruff format, isort)
  • I have performed a self-review of my code
  • I have added/updated contracts (@icontract, @beartype)
  • I have added/updated docstrings (Google style)
  • I have made corresponding changes to documentation
  • My changes generate no new warnings (basedpyright, ruff, pylint)
  • All tests pass locally
  • I have added tests that prove my fix/feature works
  • Any dependent changes have been merged

Quality Gates Status

  • Type checking ✅ (hatch run type-check)
  • Linting ✅ (hatch run lint)
  • Contract validation ✅ (hatch run contract-test-contracts)
  • Contract exploration ✅ (hatch run contract-test-exploration)
  • Scenario tests ✅ (hatch run contract-test-scenarios)

Screenshots/Recordings (if applicable)

N/A (documentation/OpenSpec artifact updates).

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

architecture Architecture and design changes bug Something isn't working documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Change] Architecture documentation discrepancies remediation

1 participant