Back to list
dwmkerr

effective-shell-migration

by dwmkerr

Text, samples and website for my 'Effective Shell' series.

760🍴 90📅 Jan 21, 2026

SKILL.md


name: effective-shell-migration description: This skill should be used when migrating book content to website, converting chapter formatting, or making any changes to migrated content. Use when the user mentions "migration", "book content", "chapter", or edits files in docs/ that correspond to book chapters.

Effective Shell Migration

Converts published book content to website format while preserving the author's intent.

Core Principle

Never change book content. The published text is authoritative. Only convert formatting—never edit substance.

Quick Reference

Typography

CharacterCorrectIncorrect
Em-dash (U+2014)--- or --
En-dash (U+2013)--
Quotes"straight""curly"

Format Conversions

Book FormatWebsite Format
**Note** blocks:::note admonition
[key]{.smallcaps}<kbd>Key</kbd>
**Menu**4**Item****Menu > Item**
Page referencesSection links or remove
Figure X-Y: Caption![Caption](./image.png)

Code Blocks

# Book format (with \$ prompt marker)
\$ **command here**
output

# Website format
```bash
$ command here
output

## Detailed References

- [Typography Rules](./references/typography.md) - Em-dashes, quotes, special characters
- [Formatting Guide](./references/formatting.md) - Admonitions, keyboard shortcuts, code blocks
- [Workflow Checklist](./references/workflow.md) - Step-by-step migration process

## Validation Checklist

Before committing migrated content:

- [ ] No `---` used as em-dashes (use `—`)
- [ ] No curly quotes (use straight quotes)
- [ ] `:::note` admonitions for note blocks
- [ ] `<kbd>` tags for keyboard keys
- [ ] Code blocks have language specifier
- [ ] Page references removed or converted to links
- [ ] All figures copied and referenced
- [ ] Build passes (`npm run build`)

## Samples Installation Command

The canonical command to install samples is:

```bash
curl -fsSL effective.sh | bash

Always use this form (not curl effective.sh | sh).

Source Files

Book chapters: ~/repos/github/dwmkerr/effective-shell-book/migration/chapters/ Book images: ~/repos/github/dwmkerr/effective-shell-book/from-rachel/images/for-prod/ Final manuscript: ~/repos/github/dwmkerr/effective-shell-book/zz-manuscript/EffectiveShell_txt_FIN.docx

Score

Total Score

70/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 500以上

+10
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

+5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon