Skip to content

Fix/cli docs overview fix#2024

Open
VitorAEltz wants to merge 3 commits intomainfrom
fix/cli-docs-overview-fix
Open

Fix/cli docs overview fix#2024
VitorAEltz wants to merge 3 commits intomainfrom
fix/cli-docs-overview-fix

Conversation

@VitorAEltz
Copy link
Contributor

Here's a PR description for the Azion CLI documentation improvements:


PR: Improve Azion CLI Overview Documentation

Summary

Refactored the Azion CLI overview documentation (EN and PT-BR) to align with competitor best practices and improve scannability.

Changes

Issues Fixed

  • Removed private video - YouTube iframe removed from EN version (was already removed from PT-BR)
  • Consolidated bullet list - Reduced from 9 items to 4 focused capabilities (cognitive load best practice: 3-5 items)
  • Added remote install script - Modern one-liner installation as recommended method: curl -fsSL https://cli.azion.app/install.sh | bash
  • Added Quick Start section - Clear 4-command workflow (install → login → init → deploy)
  • Simplified Web Frameworks section - Replaced long list with concise description + links to existing comprehensive pages

Files Modified

  • src/content/docs/en/pages/devtools/cli/azion-cli/azion-overview/azion-overview.mdx
  • src/content/docs/pt-br/pages/devtools/cli/azion-cli/azion-overview/azion-overview.mdx

Before vs After

Aspect Before After
Intro bullets 9 items 4 items
Quick Start ❌ None ✅ 4-command workflow
Install method Manual download first One-liner curl script
Web Frameworks 14+ bullet points 2 sentences + links
Video embed (EN) Private/broken Removed

Competitor Analysis

Changes align with patterns from Cloudflare Wrangler, Vercel CLI, Fastly CLI, and Supabase CLI documentation.

Testing

  • Verify remote install script works: curl -fsSL https://cli.azion.app/install.sh | bash
  • Verify EN page renders correctly
  • Verify PT-BR page renders correctly
  • Verify framework links resolve correctly

@VitorAEltz VitorAEltz requested a review from a team as a code owner February 16, 2026 14:31
@VitorAEltz VitorAEltz requested a review from arturdj February 16, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants