docs(website): component image improvement (#51)

* docs(README): add docs editing instructions Signed-off-by: jrhender <john.henderson@energyweb.org> * docs(website): update component img with border Signed-off-by: jrhender <john.henderson@energyweb.org> * docs(README): add note about docs website publishing Signed-off-by: jrhender <john.henderson@energyweb.org> --------- Signed-off-by: jrhender <john.henderson@energyweb.org>
openwallet-foundation-labs · Feb 6, 2025 · b4ff7b5 · b4ff7b5
1 parent 1475e1f
commit b4ff7b5
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ The Architecture Decisions Records can be found [here](apps/vc-api/docs/architec
 
 The [ADR Tools command line tool](https://github.com/npryce/adr-tools) can be used to add new ADRs.
 
-## Installation
+## App Development
 This repository is a monorepo that uses [Rush](https://rushjs.io/) with the PNPM package manager.
 
 PNPM is used for its speed and solution to NPM doppelgangers (as well as being the default option for rush).
@@ -66,6 +66,20 @@ To run tests across all apps and libraries in one command, a rush script has bee
 $ rush test
 ```
 
+## Docs Editing
+
+To edit the documentation, you can run the following command to start the docs server:
+
+```sh
+docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+```
+
+If it's not working, the [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write) could be helpful for troubleshooting.
+
+### Docs Publishing
+
+The docs website is published by merging into the `develop` branch (see ./github/workflows/docs.yml).
+
 ## Contributing Guidelines 
 See [contributing.md](./contributing.md)
 

diff --git a/docs/image-src.txt b/docs/image-src.txt
@@ -0,0 +1,3 @@
+Source files for the images are available here:
+
+- Component diagram: https://docs.google.com/drawings/d/1HMEzctdQpapeff2amePwDL5G0ny8F9HkAQqKytSi9Hs/edit?usp=sharing
diff --git a/docs/img/VC API Components - OWF Copy.svg b/docs/img/VC API Components - OWF Copy.svg
diff --git a/docs/index.md b/docs/index.md
@@ -24,7 +24,7 @@ The VC API endpoints are on the service components and are called by coordinator
 The expected callers of the VC API endpoints are listed in the specification [component overview](https://w3c-ccg.github.io/vc-api/#api-component-overview).
 The relationship between the components is shown in the diagram below.
 
-![VC API Components](https://w3c-ccg.github.io/vc-api/diagrams/components.svg)
+![VC API Components](img/VC%20API%20Components%20-%20OWF%20Copy.svg)
 
 As the project is an implementation of the VC API specification, the project provides the service components and is flexible in how the coordinator components are implemented.
 The coordinator executes the business rules and policies and is therefore specific to the use cases of an organization.
@@ -37,5 +37,6 @@ The coordinator executes the business rules and policies and is therefore specif
 ## Questions or Feedback
 
 If you have questions or feedback, please either:
+
 - Open an issue on the [GitHub repository](https://github.com/openwallet-foundation-labs/vc-api)
 - Post a message in the [VC-API channel of the OWF Discord](https://discord.gg/3B2nFmHsqt)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Source files for the images are available here:

		- Component diagram: https://docs.google.com/drawings/d/1HMEzctdQpapeff2amePwDL5G0ny8F9HkAQqKytSi9Hs/edit?usp=sharing