Skip to content

docs: restyle documentation to match AWS Developer Guide - #5426

Merged
dreamorosi merged 5 commits into
mainfrom
docs/aws-style-exploration
Aug 3, 2026
Merged

dreamorosi merged 5 commits into
mainfrom
docs/aws-style-exploration

Conversation

@dreamorosi

@dreamorosi dreamorosi commented Jul 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Restyle the MkDocs Material documentation to visually align with AWS Developer Guide and Cloudscape patterns. This is a maintainer-requested exploration; URLs and asset/licensing details can be confirmed before merge.

Changes

  • Add AWS-style header with logo, utility top bar, preferences menu, mega menus, search, and console link.
  • Add AWS-style footer with topic links, dark link panel, and legal bar.
  • Restructure navigation with a guide-title sidebar, collapsible state, top-level features, and Resources last.
  • Restyle right rail, typography, color tokens, light/dark themes, and callouts using self-hosted Amazon Ember.
  • Simplify homepage/language links, align llms.txt sections, and remove new status badges.
  • Known limitations: some megamenu/footer URLs are best-known placeholders pending confirmation.
  • Known limitations: Amazon Ember fonts are extracted from AWS docs CSS and need docs-team licensing sign-off.
  • Known limitations: layout differences remain where Material structure differs from Cloudscape.

Issue number: closes #5522


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Align the MkDocs Material UI with AWS Developer Guide patterns.

Add AWS-style header, footer, navigation, right rail, and callout styling.

Restructure the docs navigation and remove outdated homepage cards and badges.
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Jul 8, 2026
Match the AWS docs sidebar edge with a responsive vertical divider. Keep the divider hidden when the sidebar collapses and adapt it for dark mode.
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added size/XXL PRs with 1K+ LOC, largely documentation related and removed size/XXL PRs with 1K+ LOC, largely documentation related labels Jul 8, 2026
@sonarqubecloud

sonarqubecloud Bot commented Jul 8, 2026

Copy link
Copy Markdown

@dreamorosi
dreamorosi requested a review from svozza July 31, 2026 22:45
@dreamorosi
dreamorosi marked this pull request as ready for review July 31, 2026 22:45
@dreamorosi

Copy link
Copy Markdown
Contributor Author

@svozza I think this is ready to be merged - I have done a couple extra adversarial reviews and I have resolved all the useful SonarCube findings (note that since we disconnected the integration it won't re evaluate).

With this, I feel confident with merging this any time

@dreamorosi
dreamorosi merged commit ea573bc into main Aug 3, 2026
38 checks passed
@dreamorosi
dreamorosi deleted the docs/aws-style-exploration branch August 3, 2026 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XXL PRs with 1K+ LOC, largely documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Maintenance: restyle documentation to match AWS Developer Guide

2 participants