code sample structure

Author: tomcrane

dlcs-docs-client/README.md

@@ -0,0 +1,4 @@
+# Code samples for IIIF-CS
+
+1. Create an .env file with your settings, using the example in [example.env](example.env)
+2. Run the code samples for each documentation page. Some are split into multiple steps.

dlcs-docs-client/main.py

@@ -5,12 +5,18 @@ sidebar:
    order: 1
 ---
 
-import { Aside } from '@astrojs/starlight/components';
+import { Card, Aside } from '@astrojs/starlight/components';
 
 This section goes into more detail on the IIIF Cloud Platform API and the resources it operates on.
 
 The API has been designed to support many types of usage, from simple ad hoc creation of IIIF resources to large scale asset delivery with tens of millions of assets. The API allows you to use IIIF Cloud Services as an application development platform - providing all the IIIF and asset delivery features you need to build custom applications and workflows.
 
+<Card title="Sample code" icon="seti:python">
+    Each page of the API documentation is accompanied by some sample Python code.<br/>
+    The samples use some deliberately simple IIIF-CS Client helpers.<br/>
+    The code for this overview page is <a href="https://github.com/dlcs/public-docs/blob/main/dlcs-docs-client/p01_overview/overview.py">here</a>.
+</Card>
+
 ## API hostname
 
 The API is available on the `api.` subdomain of your platform instance. This documentation assumes the platform is available for public content at `https://dlcs.example` and therefore the root of the API throughout the documentation is at `https://api.dlcs.example`. Your instance of the platform may be on a different domain, e.g., `https://dlc.services` with the API at `https://api.dlc.services`.