Skip to content

Update documentation for new init/install workflows #16

@danielmeppiel

Description

@danielmeppiel

Summary

Update all documentation to reflect the new minimal-first init/install workflows that prioritize brownfield adoption and npm parity.

Scope

Documentation Files to Update

1. README.md

  • Quick Start - Update to show minimal workflow
    # Old
    apm init my-project
    cd my-project
    apm install
    
    # New
    cd existing-project
    apm install org/standards  # Auto-creates apm.yml!
  • What You Just Built - Remove references to template files
  • Key Commands - Update apm init description

2. docs/getting-started.md

  • Remove greenfield-only focus
  • Add brownfield adoption section prominently
  • Update init command examples
  • Show auto-bootstrap workflow
  • Update example outputs

3. docs/cli-reference.md

  • apm init - Update to minimal behavior only
    OLD: "Initialize APM project with templates and examples"
    NEW: "Initialize APM project (creates minimal apm.yml)"
    
  • apm install - Document auto-bootstrap behavior
  • Update all command examples
  • Remove template-related flags/options

4. CONTRIBUTING.md

  • Update development workflow examples
  • Update test project setup instructions

Key Messaging Changes

Remove

  • ❌ "Full scaffolding with examples"
  • ❌ "Template-based project setup"
  • ❌ References to hello-world.prompt.md, feature-implementation.prompt.md
  • ❌ "Interactive project wizard" (still interactive, but minimal)

Add

  • ✅ "Minimal by default, like npm"
  • ✅ "Works in any directory"
  • ✅ "Brownfield-friendly - no file pollution"
  • ✅ "Auto-bootstrap with apm install <package>"
  • ✅ "One-liner adoption for existing repos"

New Documentation Sections

Brownfield Adoption Guide

## Adopting APM in Existing Projects

APM works seamlessly with existing codebases:

1. **Install shared context** (auto-creates apm.yml):
   ```bash
   cd your-existing-repo
   apm install myorg/standards myorg/chatmodes
  1. Compile and use:
    apm compile
    apm run workflow-name

That's it! No manual configuration needed.


### Quick Reference
```markdown
| Scenario | Command | Result |
|----------|---------|--------|
| New project | `apm init my-app` | Creates my-app/ with apm.yml |
| Existing project | `apm install org/pkg` | Auto-creates apm.yml + installs |
| Install deps | `apm install` | Installs from existing apm.yml |

Files NOT to Change

  • CHANGELOG.md - Will be updated separately for release
  • Issue/PR templates - No changes needed
  • API documentation - No API changes

Acceptance Criteria

  • README.md updated with minimal workflow
  • Quick Start shows brownfield adoption prominently
  • docs/getting-started.md has brownfield section
  • docs/cli-reference.md reflects new behavior
  • All code examples use new commands
  • No references to removed template files
  • New "Brownfield Adoption" section added
  • Quick reference table added
  • All examples tested and verified accurate

Dependencies

Related

Part of npm-parity redesign for brownfield adoption

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions