Merge pull request #189 from zdocapp/upstreawm/fix-markdownlint-error

fix: resolve markdownlint issues in documentation
This commit is contained in:
Affaan Mustafa
2026-02-11 05:56:30 -08:00
committed by GitHub
5 changed files with 33 additions and 32 deletions

View File

@@ -78,7 +78,7 @@ EOF",
``` ```
**Model Parameter Notes**: **Model Parameter Notes**:
- `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview ` (note trailing space); use empty string for codex - `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview` (note trailing space); use empty string for codex
**Role Prompts**: **Role Prompts**:

View File

@@ -37,7 +37,7 @@ EOF",
``` ```
**Model Parameter Notes**: **Model Parameter Notes**:
- `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview ` (note trailing space); use empty string for codex - `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview` (note trailing space); use empty string for codex
**Role Prompts**: **Role Prompts**:

View File

@@ -66,7 +66,7 @@ EOF",
``` ```
**Model Parameter Notes**: **Model Parameter Notes**:
- `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview ` (note trailing space); use empty string for codex - `{{GEMINI_MODEL_FLAG}}`: When using `--backend gemini`, replace with `--gemini-model gemini-3-pro-preview` (note trailing space); use empty string for codex
**Role Prompts**: **Role Prompts**:

View File

@@ -107,68 +107,68 @@ proc.on('close', (code) => process.exit(code));
## Command File Templates (Minimal Content) ## Command File Templates (Minimal Content)
### pm2-all.md (Start all + monit) ### pm2-all.md (Start all + monit)
```markdown ````markdown
Start all services and open PM2 monitor. Start all services and open PM2 monitor.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 monit" cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 monit"
\`\`\`
``` ```
````
### pm2-all-stop.md ### pm2-all-stop.md
```markdown ````markdown
Stop all services. Stop all services.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 stop all cd "{PROJECT_ROOT}" && pm2 stop all
\`\`\`
``` ```
````
### pm2-all-restart.md ### pm2-all-restart.md
```markdown ````markdown
Restart all services. Restart all services.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 restart all cd "{PROJECT_ROOT}" && pm2 restart all
\`\`\`
``` ```
````
### pm2-{port}.md (Start single + logs) ### pm2-{port}.md (Start single + logs)
```markdown ````markdown
Start {name} ({port}) and open logs. Start {name} ({port}) and open logs.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs --only {name} && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 logs {name}" cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs --only {name} && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 logs {name}"
\`\`\`
``` ```
````
### pm2-{port}-stop.md ### pm2-{port}-stop.md
```markdown ````markdown
Stop {name} ({port}). Stop {name} ({port}).
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 stop {name} cd "{PROJECT_ROOT}" && pm2 stop {name}
\`\`\`
``` ```
````
### pm2-{port}-restart.md ### pm2-{port}-restart.md
```markdown ````markdown
Restart {name} ({port}). Restart {name} ({port}).
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 restart {name} cd "{PROJECT_ROOT}" && pm2 restart {name}
\`\`\`
``` ```
````
### pm2-logs.md ### pm2-logs.md
```markdown ````markdown
View all PM2 logs. View all PM2 logs.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 logs cd "{PROJECT_ROOT}" && pm2 logs
\`\`\`
``` ```
````
### pm2-status.md ### pm2-status.md
```markdown ````markdown
View PM2 status. View PM2 status.
\`\`\`bash ```bash
cd "{PROJECT_ROOT}" && pm2 status cd "{PROJECT_ROOT}" && pm2 status
\`\`\`
``` ```
````
### PowerShell Scripts (pm2-logs-{port}.ps1) ### PowerShell Scripts (pm2-logs-{port}.ps1)
```powershell ```powershell
@@ -213,7 +213,7 @@ Based on `$ARGUMENTS`, execute init:
After generating files, append PM2 section to project's `CLAUDE.md` (create if not exists): After generating files, append PM2 section to project's `CLAUDE.md` (create if not exists):
```markdown ````markdown
## PM2 Services ## PM2 Services
| Port | Name | Type | | Port | Name | Type |
@@ -230,7 +230,7 @@ pm2 logs / pm2 status / pm2 monit
pm2 save # Save process list pm2 save # Save process list
pm2 resurrect # Restore saved list pm2 resurrect # Restore saved list
``` ```
``` ````
**Rules for CLAUDE.md update:** **Rules for CLAUDE.md update:**
- If PM2 section exists, replace it - If PM2 section exists, replace it
@@ -247,6 +247,7 @@ After all files generated, output:
## PM2 Init Complete ## PM2 Init Complete
**Services:** **Services:**
| Port | Name | Type | | Port | Name | Type |
|------|------|------| |------|------|------|
| {port} | {name} | {type} | | {port} | {name} | {type} |
@@ -254,10 +255,10 @@ After all files generated, output:
**Claude Commands:** /pm2-all, /pm2-all-stop, /pm2-{port}, /pm2-{port}-stop, /pm2-logs, /pm2-status **Claude Commands:** /pm2-all, /pm2-all-stop, /pm2-{port}, /pm2-{port}-stop, /pm2-logs, /pm2-status
**Terminal Commands:** **Terminal Commands:**
# First time (with config file) ## First time (with config file)
pm2 start ecosystem.config.cjs && pm2 save pm2 start ecosystem.config.cjs && pm2 save
# After first time (simplified) ## After first time (simplified)
pm2 start all # Start all pm2 start all # Start all
pm2 stop all # Stop all pm2 stop all # Stop all
pm2 restart all # Restart all pm2 restart all # Restart all

View File

@@ -9,7 +9,7 @@ Process documents with the [Nutrient DWS Processor API](https://www.nutrient.io/
## Setup ## Setup
Get a free API key at **https://dashboard.nutrient.io/sign_up/?product=processor** Get a free API key at **[nutrient.io](https://dashboard.nutrient.io/sign_up/?product=processor)**
```bash ```bash
export NUTRIENT_API_KEY="pdf_live_..." export NUTRIENT_API_KEY="pdf_live_..."