@mytechtoday/augment-extensions 0.2.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +614 -39
- package/augment-extensions/coding-standards/bash/README.md +196 -0
- package/augment-extensions/coding-standards/bash/module.json +163 -0
- package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -0
- package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -0
- package/augment-extensions/coding-standards/css/README.md +40 -0
- package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/css/module.json +44 -0
- package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html/README.md +40 -0
- package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html/module.json +44 -0
- package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/README.md +194 -0
- package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -0
- package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -0
- package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -0
- package/augment-extensions/coding-standards/html-css-js/module.json +48 -0
- package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -0
- package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -0
- package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -0
- package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/js/README.md +46 -0
- package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -0
- package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -0
- package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -0
- package/augment-extensions/coding-standards/js/module.json +49 -0
- package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -0
- package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -0
- package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -0
- package/augment-extensions/coding-standards/js/rules/performance.md +463 -0
- package/augment-extensions/coding-standards/js/rules/tooling.md +543 -0
- package/augment-extensions/coding-standards/php/README.md +248 -0
- package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -0
- package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -0
- package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -0
- package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -0
- package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -0
- package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -0
- package/augment-extensions/coding-standards/php/module.json +166 -0
- package/augment-extensions/coding-standards/php/rules/api-development.md +480 -0
- package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -0
- package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -0
- package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -0
- package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -0
- package/augment-extensions/coding-standards/php/rules/documentation.md +425 -0
- package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -0
- package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -0
- package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -0
- package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -0
- package/augment-extensions/coding-standards/php/rules/performance.md +392 -0
- package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -0
- package/augment-extensions/coding-standards/php/rules/security.md +358 -0
- package/augment-extensions/coding-standards/php/rules/testing.md +403 -0
- package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -0
- package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -0
- package/augment-extensions/coding-standards/powershell/README.md +154 -0
- package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -0
- package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -0
- package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -0
- package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -0
- package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -0
- package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -0
- package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -0
- package/augment-extensions/coding-standards/powershell/module.json +165 -0
- package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -0
- package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -0
- package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -0
- package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -0
- package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -0
- package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -0
- package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -0
- package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -0
- package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -0
- package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -0
- package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -0
- package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -0
- package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -0
- package/augment-extensions/coding-standards/python/README.md +12 -8
- package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -0
- package/augment-extensions/coding-standards/python/module.json +8 -4
- package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -0
- package/augment-extensions/coding-standards/python/rules/documentation.md +831 -0
- package/augment-extensions/coding-standards/python/rules/error-handling.md +855 -68
- package/augment-extensions/coding-standards/python/rules/testing.md +409 -0
- package/augment-extensions/coding-standards/python/rules/tooling.md +446 -0
- package/augment-extensions/coding-standards/python/rules/type-hints.md +115 -50
- package/augment-extensions/collections/html-css-js/README.md +82 -0
- package/augment-extensions/collections/html-css-js/collection.json +41 -0
- package/augment-extensions/domain-rules/database/README.md +161 -0
- package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -0
- package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -0
- package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -0
- package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -0
- package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -0
- package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -0
- package/augment-extensions/domain-rules/database/module.json +28 -0
- package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -0
- package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -0
- package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -0
- package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -0
- package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -0
- package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -0
- package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -0
- package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -0
- package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -0
- package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -0
- package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -0
- package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -0
- package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -0
- package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -0
- package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -0
- package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -0
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -0
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -0
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/README.md +136 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/SCHEMA-VALIDATION-REPORT.md +216 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/brand-kit-example.yaml +292 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/campaign-brief-example.yaml +389 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/content-calendar-example.yaml +643 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/email-newsletter-example.md +376 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/landing-page-example.md +934 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/ppc-ad-copy-example.md +301 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/seo-blog-post-example.md +347 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/examples/social-media-campaign-example.md +606 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/module.json +50 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/affiliate-influencer-marketing.md +593 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/asset-management.md +418 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/brand-consistency.md +210 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/content-marketing.md +337 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/conversion-optimization.md +455 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/direct-sales.md +499 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/email-marketing.md +439 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/legal-compliance.md +227 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/ppc-advertising.md +569 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/seo-optimization.md +470 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/social-media-marketing.md +414 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/rules/universal-marketing.md +177 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/asset-inventory.schema.json +247 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/brand-kit.schema.json +326 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/campaign-brief.schema.json +342 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/color-palette.schema.json +223 -0
- package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/content-template.schema.json +383 -0
- package/augment-extensions/domain-rules/mcp/README.md +150 -0
- package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -0
- package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -0
- package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -0
- package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -0
- package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -0
- package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -0
- package/augment-extensions/domain-rules/mcp/module.json +49 -0
- package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -0
- package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -0
- package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -0
- package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -0
- package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -0
- package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -0
- package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -0
- package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -0
- package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -0
- package/augment-extensions/workflows/beads/module.json +4 -3
- package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -0
- package/augment-extensions/workflows/beads-integration/README.md +143 -0
- package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -0
- package/augment-extensions/workflows/beads-integration/config/schema.json +140 -0
- package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -0
- package/augment-extensions/workflows/beads-integration/module.json +75 -0
- package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -0
- package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -0
- package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -0
- package/augment-extensions/workflows/database/README.md +195 -0
- package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -0
- package/augment-extensions/workflows/database/examples/migration-example.md +498 -0
- package/augment-extensions/workflows/database/examples/optimization-example.md +496 -0
- package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -0
- package/augment-extensions/workflows/database/module.json +42 -0
- package/augment-extensions/workflows/database/rules/data-migration.md +249 -0
- package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -0
- package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -0
- package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -0
- package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -0
- package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -0
- package/augment-extensions/workflows/database/rules/workflow.md +458 -0
- package/augment-extensions/workflows/openspec/module.json +4 -3
- package/augment-extensions/writing-standards/screenplay/README.md +300 -0
- package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -0
- package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -0
- package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -0
- package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -0
- package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -0
- package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -0
- package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -0
- package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -0
- package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -0
- package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -0
- package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -0
- package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -0
- package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -0
- package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -0
- package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -0
- package/augment-extensions/writing-standards/screenplay/module.json +124 -0
- package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -0
- package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -0
- package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -0
- package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -0
- package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -0
- package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -0
- package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -0
- package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -0
- package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -0
- package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -0
- package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -0
- package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -0
- package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -0
- package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -0
- package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -0
- package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -0
- package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -0
- package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -0
- package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -0
- package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -0
- package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -0
- package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -0
- package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -0
- package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -0
- package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -0
- package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -0
- package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -0
- package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -0
- package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -0
- package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -0
- package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -0
- package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -0
- package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -0
- package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -0
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -0
- package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -0
- package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -0
- package/cli/MODULES.md +302 -0
- package/cli/dist/cli.js +168 -10
- package/cli/dist/cli.js.map +1 -1
- package/cli/dist/commands/catalog.d.ts +13 -0
- package/cli/dist/commands/catalog.d.ts.map +1 -0
- package/cli/dist/commands/catalog.js +104 -0
- package/cli/dist/commands/catalog.js.map +1 -0
- package/cli/dist/commands/gui.d.ts +6 -0
- package/cli/dist/commands/gui.d.ts.map +1 -0
- package/cli/dist/commands/gui.js +211 -0
- package/cli/dist/commands/gui.js.map +1 -0
- package/cli/dist/commands/init.d.ts.map +1 -1
- package/cli/dist/commands/init.js +12 -0
- package/cli/dist/commands/init.js.map +1 -1
- package/cli/dist/commands/install-rules.d.ts +14 -0
- package/cli/dist/commands/install-rules.d.ts.map +1 -0
- package/cli/dist/commands/install-rules.js +127 -0
- package/cli/dist/commands/install-rules.js.map +1 -0
- package/cli/dist/commands/link.d.ts.map +1 -1
- package/cli/dist/commands/link.js +9 -11
- package/cli/dist/commands/link.js.map +1 -1
- package/cli/dist/commands/list.d.ts.map +1 -1
- package/cli/dist/commands/list.js +11 -28
- package/cli/dist/commands/list.js.map +1 -1
- package/cli/dist/commands/mcp.d.ts +48 -0
- package/cli/dist/commands/mcp.d.ts.map +1 -0
- package/cli/dist/commands/mcp.js +229 -0
- package/cli/dist/commands/mcp.js.map +1 -0
- package/cli/dist/commands/self-remove.d.ts +7 -0
- package/cli/dist/commands/self-remove.d.ts.map +1 -0
- package/cli/dist/commands/self-remove.js +179 -0
- package/cli/dist/commands/self-remove.js.map +1 -0
- package/cli/dist/commands/show.d.ts +19 -0
- package/cli/dist/commands/show.d.ts.map +1 -1
- package/cli/dist/commands/show.js +478 -63
- package/cli/dist/commands/show.js.map +1 -1
- package/cli/dist/commands/skill.d.ts +67 -0
- package/cli/dist/commands/skill.d.ts.map +1 -0
- package/cli/dist/commands/skill.js +513 -0
- package/cli/dist/commands/skill.js.map +1 -0
- package/cli/dist/commands/unlink.d.ts +6 -0
- package/cli/dist/commands/unlink.d.ts.map +1 -0
- package/cli/dist/commands/unlink.js +115 -0
- package/cli/dist/commands/unlink.js.map +1 -0
- package/cli/dist/commands/validate.d.ts +6 -0
- package/cli/dist/commands/validate.d.ts.map +1 -0
- package/cli/dist/commands/validate.js +159 -0
- package/cli/dist/commands/validate.js.map +1 -0
- package/cli/dist/types/gui.d.ts +62 -0
- package/cli/dist/types/gui.d.ts.map +1 -0
- package/cli/dist/types/gui.js +30 -0
- package/cli/dist/types/gui.js.map +1 -0
- package/cli/dist/utils/catalog-sync.d.ts +22 -0
- package/cli/dist/utils/catalog-sync.d.ts.map +1 -0
- package/cli/dist/utils/catalog-sync.js +157 -0
- package/cli/dist/utils/catalog-sync.js.map +1 -0
- package/cli/dist/utils/character-count.d.ts +56 -0
- package/cli/dist/utils/character-count.d.ts.map +1 -0
- package/cli/dist/utils/character-count.js +190 -0
- package/cli/dist/utils/character-count.js.map +1 -0
- package/cli/dist/utils/documentation-validator.d.ts +18 -0
- package/cli/dist/utils/documentation-validator.d.ts.map +1 -0
- package/cli/dist/utils/documentation-validator.js +233 -0
- package/cli/dist/utils/documentation-validator.js.map +1 -0
- package/cli/dist/utils/gui-helpers.d.ts +23 -0
- package/cli/dist/utils/gui-helpers.d.ts.map +1 -0
- package/cli/dist/utils/gui-helpers.js +159 -0
- package/cli/dist/utils/gui-helpers.js.map +1 -0
- package/cli/dist/utils/install-rules.d.ts +32 -0
- package/cli/dist/utils/install-rules.d.ts.map +1 -0
- package/cli/dist/utils/install-rules.js +375 -0
- package/cli/dist/utils/install-rules.js.map +1 -0
- package/cli/dist/utils/mcp-integration.d.ts +70 -0
- package/cli/dist/utils/mcp-integration.d.ts.map +1 -0
- package/cli/dist/utils/mcp-integration.js +292 -0
- package/cli/dist/utils/mcp-integration.js.map +1 -0
- package/cli/dist/utils/module-system.d.ts +232 -0
- package/cli/dist/utils/module-system.d.ts.map +1 -0
- package/cli/dist/utils/module-system.js +900 -0
- package/cli/dist/utils/module-system.js.map +1 -0
- package/cli/dist/utils/modules-catalog.d.ts +33 -0
- package/cli/dist/utils/modules-catalog.d.ts.map +1 -0
- package/cli/dist/utils/modules-catalog.js +163 -0
- package/cli/dist/utils/modules-catalog.js.map +1 -0
- package/cli/dist/utils/rule-install-hooks.d.ts +19 -0
- package/cli/dist/utils/rule-install-hooks.d.ts.map +1 -0
- package/cli/dist/utils/rule-install-hooks.js +224 -0
- package/cli/dist/utils/rule-install-hooks.js.map +1 -0
- package/cli/dist/utils/skill-system.d.ts +95 -0
- package/cli/dist/utils/skill-system.d.ts.map +1 -0
- package/cli/dist/utils/skill-system.js +313 -0
- package/cli/dist/utils/skill-system.js.map +1 -0
- package/modules.md +559 -105
- package/package.json +17 -6
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
# Email Newsletter Example
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Responsive HTML email newsletter template with mobile-first design, CAN-SPAM compliance, and best practices for deliverability and engagement.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## HTML Email Template
|
|
10
|
+
|
|
11
|
+
```html
|
|
12
|
+
<!DOCTYPE html>
|
|
13
|
+
<html lang="en">
|
|
14
|
+
<head>
|
|
15
|
+
<meta charset="UTF-8">
|
|
16
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
17
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
18
|
+
<title>Monthly Newsletter - January 2026</title>
|
|
19
|
+
<style>
|
|
20
|
+
/* Reset styles */
|
|
21
|
+
body, table, td, a { -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
|
|
22
|
+
table, td { mso-table-lspace: 0pt; mso-table-rspace: 0pt; }
|
|
23
|
+
img { -ms-interpolation-mode: bicubic; border: 0; height: auto; line-height: 100%; outline: none; text-decoration: none; }
|
|
24
|
+
|
|
25
|
+
/* Base styles */
|
|
26
|
+
body {
|
|
27
|
+
margin: 0;
|
|
28
|
+
padding: 0;
|
|
29
|
+
width: 100% !important;
|
|
30
|
+
font-family: Arial, Helvetica, sans-serif;
|
|
31
|
+
background-color: #f4f4f4;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/* Container */
|
|
35
|
+
.email-container {
|
|
36
|
+
max-width: 600px;
|
|
37
|
+
margin: 0 auto;
|
|
38
|
+
background-color: #ffffff;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/* Header */
|
|
42
|
+
.header {
|
|
43
|
+
background-color: #0066cc;
|
|
44
|
+
padding: 20px;
|
|
45
|
+
text-align: center;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
.header img {
|
|
49
|
+
max-width: 200px;
|
|
50
|
+
height: auto;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/* Content */
|
|
54
|
+
.content {
|
|
55
|
+
padding: 30px 20px;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
.content h1 {
|
|
59
|
+
color: #333333;
|
|
60
|
+
font-size: 24px;
|
|
61
|
+
margin: 0 0 20px 0;
|
|
62
|
+
line-height: 1.3;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
.content h2 {
|
|
66
|
+
color: #0066cc;
|
|
67
|
+
font-size: 20px;
|
|
68
|
+
margin: 30px 0 15px 0;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
.content p {
|
|
72
|
+
color: #666666;
|
|
73
|
+
font-size: 16px;
|
|
74
|
+
line-height: 1.6;
|
|
75
|
+
margin: 0 0 15px 0;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/* Button */
|
|
79
|
+
.button {
|
|
80
|
+
display: inline-block;
|
|
81
|
+
padding: 14px 30px;
|
|
82
|
+
background-color: #0066cc;
|
|
83
|
+
color: #ffffff !important;
|
|
84
|
+
text-decoration: none;
|
|
85
|
+
border-radius: 5px;
|
|
86
|
+
font-weight: bold;
|
|
87
|
+
margin: 10px 0;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
.button:hover {
|
|
91
|
+
background-color: #0052a3;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/* Article card */
|
|
95
|
+
.article-card {
|
|
96
|
+
border: 1px solid #e0e0e0;
|
|
97
|
+
border-radius: 8px;
|
|
98
|
+
padding: 20px;
|
|
99
|
+
margin: 20px 0;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
.article-card img {
|
|
103
|
+
max-width: 100%;
|
|
104
|
+
height: auto;
|
|
105
|
+
border-radius: 5px;
|
|
106
|
+
margin-bottom: 15px;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/* Footer */
|
|
110
|
+
.footer {
|
|
111
|
+
background-color: #333333;
|
|
112
|
+
color: #ffffff;
|
|
113
|
+
padding: 30px 20px;
|
|
114
|
+
text-align: center;
|
|
115
|
+
font-size: 14px;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
.footer a {
|
|
119
|
+
color: #ffffff;
|
|
120
|
+
text-decoration: underline;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
.social-links {
|
|
124
|
+
margin: 20px 0;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
.social-links a {
|
|
128
|
+
display: inline-block;
|
|
129
|
+
margin: 0 10px;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/* Mobile responsive */
|
|
133
|
+
@media only screen and (max-width: 600px) {
|
|
134
|
+
.content h1 { font-size: 20px !important; }
|
|
135
|
+
.content h2 { font-size: 18px !important; }
|
|
136
|
+
.content p { font-size: 14px !important; }
|
|
137
|
+
.button { display: block !important; width: 100% !important; }
|
|
138
|
+
}
|
|
139
|
+
</style>
|
|
140
|
+
</head>
|
|
141
|
+
<body>
|
|
142
|
+
<!-- Preheader text (hidden but shows in inbox preview) -->
|
|
143
|
+
<div style="display: none; max-height: 0; overflow: hidden;">
|
|
144
|
+
Your monthly dose of insights, tips, and updates from [Company Name]
|
|
145
|
+
</div>
|
|
146
|
+
|
|
147
|
+
<!-- Email container -->
|
|
148
|
+
<table role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%">
|
|
149
|
+
<tr>
|
|
150
|
+
<td style="padding: 20px 0;">
|
|
151
|
+
<table role="presentation" cellspacing="0" cellpadding="0" border="0" class="email-container">
|
|
152
|
+
|
|
153
|
+
<!-- Header -->
|
|
154
|
+
<tr>
|
|
155
|
+
<td class="header">
|
|
156
|
+
<img src="https://cdn.example.com/logo-white.png" alt="Company Logo" width="200">
|
|
157
|
+
</td>
|
|
158
|
+
</tr>
|
|
159
|
+
|
|
160
|
+
<!-- Main content -->
|
|
161
|
+
<tr>
|
|
162
|
+
<td class="content">
|
|
163
|
+
<h1>Welcome to Our January Newsletter! 🎉</h1>
|
|
164
|
+
|
|
165
|
+
<p>Hi {{first_name}},</p>
|
|
166
|
+
|
|
167
|
+
<p>Happy New Year! We're excited to share what's new this month, including product updates, helpful resources, and exclusive offers just for you.</p>
|
|
168
|
+
|
|
169
|
+
<!-- Featured article -->
|
|
170
|
+
<div class="article-card">
|
|
171
|
+
<img src="https://cdn.example.com/featured-article.jpg" alt="Featured Article">
|
|
172
|
+
<h2>10 Strategies to Boost Your Productivity in 2026</h2>
|
|
173
|
+
<p>Discover proven techniques to maximize your efficiency and achieve your goals this year.</p>
|
|
174
|
+
<a href="https://example.com/article/productivity-2026" class="button">Read More</a>
|
|
175
|
+
</div>
|
|
176
|
+
|
|
177
|
+
<!-- Product update -->
|
|
178
|
+
<h2>🚀 New Feature: AI-Powered Analytics</h2>
|
|
179
|
+
<p>We've just launched our most requested feature! Get instant insights from your data with our new AI-powered analytics dashboard.</p>
|
|
180
|
+
<a href="https://example.com/features/ai-analytics" class="button">Try It Now</a>
|
|
181
|
+
|
|
182
|
+
<!-- Blog posts -->
|
|
183
|
+
<h2>📚 Latest from Our Blog</h2>
|
|
184
|
+
|
|
185
|
+
<p><strong><a href="https://example.com/blog/post-1">How to Optimize Your Workflow</a></strong><br>
|
|
186
|
+
Learn the secrets to streamlining your daily tasks.</p>
|
|
187
|
+
|
|
188
|
+
<p><strong><a href="https://example.com/blog/post-2">Customer Success Story: Acme Corp</a></strong><br>
|
|
189
|
+
See how Acme Corp increased revenue by 150% using our platform.</p>
|
|
190
|
+
|
|
191
|
+
<p><strong><a href="https://example.com/blog/post-3">5 Common Mistakes to Avoid</a></strong><br>
|
|
192
|
+
Don't fall into these traps - here's what to watch out for.</p>
|
|
193
|
+
|
|
194
|
+
<!-- Special offer -->
|
|
195
|
+
<div style="background-color: #fff3cd; border-left: 4px solid #ffc107; padding: 15px; margin: 20px 0;">
|
|
196
|
+
<h2 style="margin-top: 0; color: #856404;">🎁 Exclusive Offer for Subscribers</h2>
|
|
197
|
+
<p style="color: #856404; margin-bottom: 10px;">Get 20% off any annual plan this month! Use code <strong>JAN2026</strong> at checkout.</p>
|
|
198
|
+
<a href="https://example.com/pricing?code=JAN2026" class="button" style="background-color: #ffc107; color: #000000 !important;">Claim Your Discount</a>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
<!-- Upcoming events -->
|
|
202
|
+
<h2>📅 Upcoming Events</h2>
|
|
203
|
+
<p><strong>Webinar: Mastering Data Analytics</strong><br>
|
|
204
|
+
January 25, 2026 at 2:00 PM EST<br>
|
|
205
|
+
<a href="https://example.com/webinar/data-analytics">Register Now</a></p>
|
|
206
|
+
|
|
207
|
+
<p><strong>Product Demo: New Features Walkthrough</strong><br>
|
|
208
|
+
February 1, 2026 at 11:00 AM EST<br>
|
|
209
|
+
<a href="https://example.com/demo/new-features">Save Your Spot</a></p>
|
|
210
|
+
|
|
211
|
+
<!-- Closing -->
|
|
212
|
+
<p style="margin-top: 30px;">Thanks for being part of our community! If you have any questions or feedback, just reply to this email.</p>
|
|
213
|
+
|
|
214
|
+
<p>Best regards,<br>
|
|
215
|
+
<strong>The [Company Name] Team</strong></p>
|
|
216
|
+
</td>
|
|
217
|
+
</tr>
|
|
218
|
+
|
|
219
|
+
<!-- Footer -->
|
|
220
|
+
<tr>
|
|
221
|
+
<td class="footer">
|
|
222
|
+
<!-- Social links -->
|
|
223
|
+
<div class="social-links">
|
|
224
|
+
<a href="https://twitter.com/company"><img src="https://cdn.example.com/icon-twitter.png" alt="Twitter" width="32"></a>
|
|
225
|
+
<a href="https://linkedin.com/company/company"><img src="https://cdn.example.com/icon-linkedin.png" alt="LinkedIn" width="32"></a>
|
|
226
|
+
<a href="https://facebook.com/company"><img src="https://cdn.example.com/icon-facebook.png" alt="Facebook" width="32"></a>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<!-- Company info -->
|
|
230
|
+
<p style="margin: 10px 0;">
|
|
231
|
+
<strong>[Company Name]</strong><br>
|
|
232
|
+
123 Main Street, Suite 100<br>
|
|
233
|
+
San Francisco, CA 94105
|
|
234
|
+
</p>
|
|
235
|
+
|
|
236
|
+
<!-- CAN-SPAM compliance -->
|
|
237
|
+
<p style="margin: 20px 0 10px 0; font-size: 12px; color: #999999;">
|
|
238
|
+
You're receiving this email because you subscribed to our newsletter.<br>
|
|
239
|
+
<a href="{{unsubscribe_url}}" style="color: #999999;">Unsubscribe</a> |
|
|
240
|
+
<a href="{{preferences_url}}" style="color: #999999;">Update Preferences</a> |
|
|
241
|
+
<a href="https://example.com/privacy" style="color: #999999;">Privacy Policy</a>
|
|
242
|
+
</p>
|
|
243
|
+
|
|
244
|
+
<p style="font-size: 12px; color: #999999;">
|
|
245
|
+
© 2026 [Company Name]. All rights reserved.
|
|
246
|
+
</p>
|
|
247
|
+
</td>
|
|
248
|
+
</tr>
|
|
249
|
+
|
|
250
|
+
</table>
|
|
251
|
+
</td>
|
|
252
|
+
</tr>
|
|
253
|
+
</table>
|
|
254
|
+
</body>
|
|
255
|
+
</html>
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
---
|
|
259
|
+
|
|
260
|
+
## CAN-SPAM Compliance Checklist
|
|
261
|
+
|
|
262
|
+
### Required Elements
|
|
263
|
+
|
|
264
|
+
✅ **Accurate "From" Information**
|
|
265
|
+
- Use real company name and email address
|
|
266
|
+
- Don't use misleading sender information
|
|
267
|
+
|
|
268
|
+
✅ **Clear Subject Line**
|
|
269
|
+
- Subject must accurately reflect email content
|
|
270
|
+
- No deceptive subject lines
|
|
271
|
+
|
|
272
|
+
✅ **Identify as Advertisement (if applicable)**
|
|
273
|
+
- Clearly disclose if email is promotional
|
|
274
|
+
|
|
275
|
+
✅ **Physical Address**
|
|
276
|
+
- Include valid physical postal address
|
|
277
|
+
- Can be street address or P.O. box
|
|
278
|
+
|
|
279
|
+
✅ **Unsubscribe Mechanism**
|
|
280
|
+
- Provide clear, conspicuous unsubscribe link
|
|
281
|
+
- Process unsubscribe requests within 10 business days
|
|
282
|
+
- Don't charge fee or require login to unsubscribe
|
|
283
|
+
|
|
284
|
+
✅ **Honor Opt-Outs Promptly**
|
|
285
|
+
- Stop sending emails within 10 business days
|
|
286
|
+
- Don't sell/transfer email addresses of unsubscribers
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
## Email Best Practices
|
|
291
|
+
|
|
292
|
+
### Subject Lines
|
|
293
|
+
|
|
294
|
+
**Good Examples:**
|
|
295
|
+
- "Your January Newsletter: New Features + Exclusive Offer 🎁"
|
|
296
|
+
- "[First Name], here's your personalized productivity guide"
|
|
297
|
+
- "Last chance: 20% off ends tonight"
|
|
298
|
+
|
|
299
|
+
**Bad Examples:**
|
|
300
|
+
- "RE: Important" (misleading)
|
|
301
|
+
- "FREE MONEY!!!" (spammy)
|
|
302
|
+
- "You won't believe this..." (clickbait)
|
|
303
|
+
|
|
304
|
+
### Preheader Text
|
|
305
|
+
|
|
306
|
+
The preheader appears after the subject line in inbox previews. Use it wisely:
|
|
307
|
+
|
|
308
|
+
```html
|
|
309
|
+
<!-- Good preheader -->
|
|
310
|
+
<div style="display: none; max-height: 0; overflow: hidden;">
|
|
311
|
+
New features, exclusive offers, and productivity tips inside
|
|
312
|
+
</div>
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Personalization
|
|
316
|
+
|
|
317
|
+
Use merge tags for personalization:
|
|
318
|
+
- `{{first_name}}` - First name
|
|
319
|
+
- `{{company}}` - Company name
|
|
320
|
+
- `{{last_purchase}}` - Last purchase date
|
|
321
|
+
- `{{custom_field}}` - Any custom field
|
|
322
|
+
|
|
323
|
+
### Mobile Optimization
|
|
324
|
+
|
|
325
|
+
- Use single-column layout
|
|
326
|
+
- Minimum 14px font size
|
|
327
|
+
- Large, tappable buttons (44x44px minimum)
|
|
328
|
+
- Optimize images for mobile (compress, use responsive images)
|
|
329
|
+
- Test on multiple devices and email clients
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
## Testing Checklist
|
|
334
|
+
|
|
335
|
+
### Before Sending
|
|
336
|
+
|
|
337
|
+
- [ ] Test on major email clients (Gmail, Outlook, Apple Mail)
|
|
338
|
+
- [ ] Test on mobile devices (iOS, Android)
|
|
339
|
+
- [ ] Check all links work correctly
|
|
340
|
+
- [ ] Verify personalization tokens populate correctly
|
|
341
|
+
- [ ] Test unsubscribe link
|
|
342
|
+
- [ ] Check images load (and alt text displays if blocked)
|
|
343
|
+
- [ ] Proofread all copy
|
|
344
|
+
- [ ] Verify CAN-SPAM compliance
|
|
345
|
+
- [ ] Run spam score test (Mail Tester, Litmus)
|
|
346
|
+
- [ ] Send test to team for review
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## Performance Metrics
|
|
351
|
+
|
|
352
|
+
### Key Metrics to Track
|
|
353
|
+
|
|
354
|
+
- **Open Rate:** 15-25% (average), 25%+ (good)
|
|
355
|
+
- **Click-Through Rate:** 2-5% (average), 5%+ (good)
|
|
356
|
+
- **Conversion Rate:** 1-3% (average), 3%+ (good)
|
|
357
|
+
- **Unsubscribe Rate:** <0.5% (good), <0.2% (excellent)
|
|
358
|
+
- **Bounce Rate:** <2% (good), <1% (excellent)
|
|
359
|
+
- **Spam Complaint Rate:** <0.1% (critical threshold)
|
|
360
|
+
|
|
361
|
+
### A/B Testing Ideas
|
|
362
|
+
|
|
363
|
+
1. **Subject Lines:** With/without emoji, personalization, urgency
|
|
364
|
+
2. **Send Time:** Morning vs. afternoon, weekday vs. weekend
|
|
365
|
+
3. **Content:** Long vs. short, single topic vs. digest
|
|
366
|
+
4. **CTA:** Button text, color, placement
|
|
367
|
+
5. **Images:** With/without hero image, product photos
|
|
368
|
+
|
|
369
|
+
---
|
|
370
|
+
|
|
371
|
+
## Related Resources
|
|
372
|
+
|
|
373
|
+
- **conversion-optimization.md** - CTA and email optimization
|
|
374
|
+
- **content-marketing.md** - Email content strategy
|
|
375
|
+
- **universal-marketing.md** - Email metrics and KPIs
|
|
376
|
+
|