Skip to content

[Improve Existing Best Practice Guide]: Update Quick Start sections to reference slim-cli with new alias-based commands #205

@riverma

Description

@riverma

Checked for duplicates

Yes - I've already checked

Best Practice Guide Category

All

Best practice guide URL

Multiple guides need updating, including:

Describe the improvement

With the recent migration of slim-cli from SLIM-X.X numeric IDs to descriptive aliases (resolved in slim-cli issue #17), we need to update the Quick Start sections across all relevant best practice guides to reference the new alias-based slim-cli commands.

Current Problem:

  • Many guides show manual implementation steps in their Quick Start sections
  • Users have to manually download templates, copy files, and follow multi-step processes
  • The improved slim-cli automation with aliases like readme, governance-small, secrets-github is not being promoted

Proposed Improvements:

  1. Add slim-cli Quick Start sections to all applicable guides that include a template or automation option
  2. Update existing Quick Start sections to prominently feature slim-cli commands using the new alias format
  3. Include both manual and automated options with slim-cli being the recommended approach

Example of improved Quick Start section:

## Quick Start

### 🚀 Automated with slim-cli (Recommended)
```bash
# Apply the README template using slim-cli
slim apply --best-practices readme --repo-dir /path/to/your/repo

# Or apply to a remote repository
slim apply --best-practices readme --repo-urls https://github.com/your-org/your-repo

### 📋 Manual Implementation
⬇️ [Link to README Template](template-link)

Download the guide above and place in the root folder of your repository...

Guides that need updating:

  • All documentation guides (README, changelog, etc.)
  • Governance guides (governance-small, governance-medium, governance-large)
  • Security guides (secrets detection, etc.)
  • Any guide with downloadable templates or starter kits

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions