Skip to content

docs: Standardize and reposition Arcade video embeds - #603

Merged
AbhishekDoshi26 merged 9 commits into
mainfrom
feat/arcades
Jul 31, 2026
Merged

docs: Standardize and reposition Arcade video embeds#603
AbhishekDoshi26 merged 9 commits into
mainfrom
feat/arcades

Conversation

@AbhishekDoshi26

Copy link
Copy Markdown
Member

What

  • Refactored getting-started/index.mdx to use the <ArcadeEmbed /> component instead of raw <iframe> HTML.
  • Unified component imports to consistently use the ~ alias (~/components/ArcadeEmbed.astro).
  • Added a new 10s Arcade walkthrough for shorebird create my_app to code-push/create.mdx.
  • Repositioned several Arcade embeds to sit near the top of the page or their respective sections.

Why

These changes implement a newly established documentation rule: "When adding an Arcade embed to documentation, always place it near the top of the page or relevant section." Shifting the embeds upwards ensures users get immediate visual context before diving into dense step-by-step instructions.

Placements Updated

  • account/api-keys.mdx: Moved the embed to sit directly below the ## Creating an API key heading.
  • code-push/index.mdx: Moved the overview embed to the very top of the page.
  • code-push/ci/_authentication.mdx: Moved the API Key creation embed above the numbered steps.

@AbhishekDoshi26
AbhishekDoshi26 enabled auto-merge (squash) July 31, 2026 11:22
@AbhishekDoshi26
AbhishekDoshi26 merged commit c383885 into main Jul 31, 2026
5 checks passed
@AbhishekDoshi26
AbhishekDoshi26 deleted the feat/arcades branch July 31, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants