docs: Add blog post and new slash commands for development workflow

- Add blog post: 4 Essential Slash Commands I Use in Every Project
- Add new slash commands: /doc-refactor, /setup-ci-cd, /unit-test-expand
- Update slash-commands README with comprehensive documentation
- Simplify /push-all command structure
- Archive add-blog-post-slash-commands change
- Add blog-post spec and pending openspec changes
This commit is contained in:
Luong NGUYEN
2025-12-26 11:02:19 +01:00
parent 8ef1e4a0c0
commit 0fcac18357
21 changed files with 1557 additions and 397 deletions

View File

@@ -0,0 +1,20 @@
# Change: Update Slash Commands README with New Commands
## Why
The `01-slash-commands/README.md` is outdated and needs to reflect:
1. Updated `push-all.md` command with enhanced safety checks (API key validation, confirmation workflow)
2. Three new slash commands added to the folder: `doc-refactor.md`, `setup-ci-cd.md`, `unit-test-expand.md`
## What Changes
- **Update push-all documentation**: Reflect the enhanced workflow including safety checks, API key validation, and confirmation prompts
- **Add doc-refactor command**: Document the new documentation restructuring command
- **Add setup-ci-cd command**: Document the new CI/CD pipeline setup command
- **Add unit-test-expand command**: Document the new test coverage expansion command
- Update "Available Commands" section count from 4 to 7 commands
## Impact
- Affected specs: `slash-commands`
- Affected code: `01-slash-commands/README.md`

View File

@@ -0,0 +1,66 @@
## ADDED Requirements
### Requirement: Push-All Command with Safety Checks
The documentation SHALL describe the `/push-all` command with its comprehensive safety workflow including:
1. Change analysis (git status, diff, log)
2. Safety checks for secrets, API keys, large files, build artifacts
3. API key validation distinguishing real keys from placeholders
4. Confirmation prompt before proceeding
5. Conventional commit message generation
6. Error handling guidance
#### Scenario: User learns push-all safety workflow
- **WHEN** a user reads the push-all command documentation
- **THEN** they understand the multi-step safety workflow
- **AND** they know what types of files trigger warnings
- **AND** they understand they must confirm before execution
---
### Requirement: Doc-Refactor Command Documentation
The documentation SHALL describe the `/doc-refactor` command for restructuring project documentation including:
1. Project type analysis (library, API, web app, CLI, microservices)
2. Documentation centralization in `docs/` folder
3. Root README streamlining
4. Component-level documentation
5. Guide creation based on project type
#### Scenario: User uses doc-refactor command
- **WHEN** a user reads the doc-refactor documentation
- **THEN** they understand how to invoke the command
- **AND** they know what documentation structure changes to expect
- **AND** they understand the command adapts to project type
---
### Requirement: Setup-CI-CD Command Documentation
The documentation SHALL describe the `/setup-ci-cd` command for implementing quality gates including:
1. Project analysis for language and tooling detection
2. Pre-commit hook configuration with language-specific tools
3. GitHub Actions workflow creation
4. Pipeline verification steps
#### Scenario: User uses setup-ci-cd command
- **WHEN** a user reads the setup-ci-cd documentation
- **THEN** they understand the command creates pre-commit hooks
- **AND** they know GitHub Actions workflows will be generated
- **AND** they understand tools are selected based on project language
---
### Requirement: Unit-Test-Expand Command Documentation
The documentation SHALL describe the `/unit-test-expand` command for increasing test coverage including:
1. Coverage analysis to identify gaps
2. Gap identification (branches, error paths, boundaries)
3. Framework-specific test generation
4. Coverage verification
#### Scenario: User uses unit-test-expand command
- **WHEN** a user reads the unit-test-expand documentation
- **THEN** they understand the command analyzes existing coverage
- **AND** they know it targets untested branches and edge cases
- **AND** they understand it works with their project's testing framework

View File

@@ -0,0 +1,7 @@
## 1. Implementation
- [x] 1.1 Update `/push-all` section in README to reflect enhanced safety checks (API key validation, confirmation workflow, detailed error handling)
- [x] 1.2 Add `/doc-refactor` section documenting the documentation restructuring command
- [x] 1.3 Add `/setup-ci-cd` section documenting the CI/CD pipeline setup command
- [x] 1.4 Add `/unit-test-expand` section documenting the test coverage expansion command
- [x] 1.5 Update section heading to reflect 8 available commands (was 4, added 4 new)