[Improve Existing Best Practice Guide]: Update Quick Start sections to reference slim-cli with new alias-based commands
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Best Practice Guide Category
All
Best practice guide URL
Multiple guides need updating, including:
- https://nasa-ammos.github.io/slim/docs/guides/documentation/readme/
- https://nasa-ammos.github.io/slim/docs/guides/governance/
- All guides with Quick Start sections that reference manual implementation
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-githubis not being promoted
Proposed Improvements:
- Add slim-cli Quick Start sections to all applicable guides that include a template or automation option
- Update existing Quick Start sections to prominently feature slim-cli commands using the new alias format
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and governance guide URLs, then inventory other guides with Quick Start sections, downloadable templates, or starter kits. Compare their manual steps with the documented slim-cli aliases such as readme and governance-small. Done means every applicable guide clearly presents automated and manual options with current commands.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100