Document designs and packages

Author: jonathan343

.gitignore

@@ -34,3 +34,6 @@ htmlcov
 *.egg-info
 dist
 .venv
+
+# mkdocs documentation
+docs/site

docs/index.md

@@ -1,17 +1 @@
-# Welcome to MkDocs
-
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+--8<-- "README.md"

docs/packages/aws-sdk-signers.md

@@ -0,0 +1 @@
+::: aws_sdk_signers

docs/packages/smithy-aws-core.md

@@ -0,0 +1 @@
+::: smithy_aws_core

docs/packages/smithy-aws-event-stream.md

@@ -0,0 +1 @@
+::: smithy_aws_event_stream

docs/packages/smithy-core.md

@@ -0,0 +1 @@
+::: smithy_core

docs/packages/smithy-http.md

@@ -0,0 +1 @@
+::: smithy_http

docs/packages/smithy-json.md

@@ -0,0 +1 @@
+::: smithy_json

mkdocs.yml

@@ -1 +1,92 @@
-site_name: My Docs
+# Project Information
+site_name: Smithy Python
+watch: [README.md]
+
+# Copyright
+copyright: Copyright © 2025, Amazon Web Services, Inc
+
+# Repository
+repo_name: smithy-lang/smithy-python
+repo_url: https://github.com/smithy-lang/smithy-python
+
+# Theme
+theme:
+  name: material
+  logo: assets/smithy-anvil.svg
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+      primary: black
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+      primary: black
+  features:
+    - navigation.path
+    - navigation.top
+    - navigation.footer
+    - content.code.copy
+
+# Plugins
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        paths: [packages/*/src]
+        options:
+          show_submodules: true
+          show_symbol_type_heading: true
+          show_symbol_type_toc: true
+
+# Navigation
+nav:
+  - index.md
+  - Packages:
+    - smithy-core: packages/smithy-core.md
+    - smithy-http: packages/smithy-http.md
+    - smithy-json: packages/smithy-json.md
+    - smithy-aws-core: packages/smithy-aws-core.md
+    - smithy-aws-event-stream: packages/smithy-aws-event-stream.md
+    - aws-sdk-signers: packages/aws-sdk-signers.md
+  - Designs:
+      - Auth: designs/auth.md
+      - Documents: designs/documents.md
+      - "Event Streams": designs/event-streams.md
+      - Exceptions: designs/exceptions.md
+      - "HTTP Interfaces": designs/http-interfaces.md
+      - Retries: designs/retries.md
+      - Serialization: designs/serialization.md
+      - Shapes: designs/shapes.md
+
+# Extensions
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - toc:
+      permalink: true
+
+# Extras
+extra:
+  social:
+  - icon: fontawesome/brands/github
+    link: https://github.com/smithy-lang/smithy-python