docs(contributing): add guide to update examples (#258)

aep-dev · Jan 7, 2025 · a0fab57 · a0fab57
1 parent 9f1caba
commit a0fab57
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -57,3 +57,15 @@ Run `./scripts/serve.sh` to:
 ### Hot reloading
 
 The development server currently does not support hot reloading.
+
+### Updating examples
+
+The example files are code-generated by [aepc](https://github.com/aep-dev/aepc)
+and copied into this repository.
+
+Specifically, the following files are copied over:
+
+| aeps file                                                        | aepc file                                                                                                                            |
+| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| [./aep/general/example.oas.yaml](./aep/general/example.oas.yaml) | [example/bookstore/v1/bookstore_openapi.json](https://github.com/aep-dev/aepc/blob/main/example/bookstore/v1/bookstore_openapi.json) |
+| [./aep/general/example.proto](./aep/general/example.proto)       | [example/bookstore/v1/bookstore.proto](https://github.com/aep-dev/aepc/blob/main/example/bookstore/v1/bookstore.proto)               |
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # API Enhancement Proposals
 
-The [AEP Project](https://aep.dev) is an API design specification and ecosystem of
-clients and tooling for protobuf and HTTP REST APIs.
+The [AEP Project](https://aep.dev) is an API design specification and ecosystem
+of clients and tooling for protobuf and HTTP REST APIs.
 
 ## Overview