Unverified Commit ca849fb5 authored by Russell Cohen's avatar Russell Cohen Committed by GitHub
Browse files

Design Doc Updates (#1347) 

* Remove makefile, add mdbook-mermaid

* Add design doc section about backwards compatibility

* fix footnotes
parent bea5f1d2

.github/workflows/github-pages.yml

+1 −0
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ jobs: 


        pushd design &>/dev/null

        cargo install mdbook

        cargo install mdbook-mermaid

        mdbook build --dest-dir ../../output

        popd &>/dev/null

design/README.md

+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ Design docs are hosted [here](https://awslabs.github.io/smithy-rs/design/). 
To render design docs locally:

```

cargo install mdbook

cargo install mdbook-mermaid

mdbook serve &

open http://localhost:3000

```

design/book.toml

+7 −1
Original line number Diff line number Diff line 
[book]

authors = ["Russell Cohen"]

authors = ["Russell Cohen", "aws-sdk-rust@amazon.com"]

language = "en"

multilingual = false

src = "src"

title = "AWS Rust SDK Design"



[preprocessor.mermaid]

command = "mdbook-mermaid"



[output.html]

additional-js = ["static/mermaid.min.js", "static/mermaid-init.js"]

design/src/SUMMARY.md

+4 −2
Original line number Diff line number Diff line
@@ -3,14 +3,15 @@ 
- [Tenets](./tenets.md)

- [Design FAQ](./faq.md)

- [Transport](transport/overview.md)

  - [Http Operations](transport/operation.md)

  - [HTTP middleware](transport/middleware.md)

  - [HTTP Operations](transport/operation.md)

  - [HTTP Middleware](transport/middleware.md)



- [Smithy](./smithy/overview.md)

    - [Simple Shapes](./smithy/simple_shapes.md)

    - [Recursive Shapes](./smithy/recursive_shapes.md)

    - [Aggregate Shapes](./smithy/aggregate_shapes.md)

    - [Endpoint Resolution](smithy/endpoint.md)

    - [Backwards Compatibility](smithy/backwards-compat.md)



- [RFCs](./rfcs/overview.md)

  - [RFC-0001: Sharing configuration between multiple clients](./rfcs/rfc0001_shared_config.md)
@@ -25,3 +26,4 @@ 
  - [RFC-0010: Waiters](./rfcs/rfc0010_waiters.md)

  - [RFC-0011: Publishing Alpha to Crates.io](./rfcs/rfc0011_crates_io_alpha_publishing.md)

  - [RFC-0012: Independent Crate Versioning](./rfcs/rfc0012_independent_crate_versioning.md)

  - [RFC-0013: Body Callback APIs](./rfcs/rfc0013_body_callback_apis.md)

design/src/endpoint.md

deleted100644 → 0
+0 −1
Original line number Diff line number Diff line 
# Endpoint Resolution