chore: improves documentation and error handling

Improves documentation for accuracy and clarity by updating descriptions and correcting code examples.

Adds error handling to code examples to enhance robustness.

Refactors file copy command in custom containers documentation for correctness.

Author: davemooreuws

docs/architecture/websites.mdx

@@ -50,14 +50,14 @@ classDef edgeLabel line-height:2;
 flowchart TD
     Developer["Developer"]
     NitricUp["nitric up"]
-    Storage["Azure Storage"]
+    BlobStorage["Azure Blob Storage"]
     FrontDoor["Azure Front Door"]
     Rewrite["Azure API Management"]
 
     Developer -->|Deploy| NitricUp
-    NitricUp -->|Upload Assets| Storage
+    NitricUp -->|Upload Assets| BlobStorage
     NitricUp -->|Create CDN| FrontDoor
-    FrontDoor -->|Serve Static Files| Storage
+    FrontDoor -->|Serve Static Files| BlobStorage
     FrontDoor -->|Rewrite /api/* to API| Rewrite
 
 classDef default line-height:1;

docs/reference/custom-containers.mdx

@@ -61,7 +61,7 @@ RUN apt-get update -y && \
 RUN pip install --upgrade pip pipenv
 
 # Copy either requirements.txt or Pipfile
-COPY requirements.tx[t] Pipfil[e] Pipfile.loc[k] ./
+COPY requirements.txt Pipfile Pipfile.lock ./
 
 # Guarantee lock file if we have a Pipfile and no Pipfile.lock
 RUN (stat Pipfile && pipenv lock) || echo "No Pipfile found"

docs/reference/env.mdx

@@ -10,10 +10,10 @@ Nitric sets a number of environment variables to help you manage your project. T
 
 If you are running your project in the cloud, build, or the run environment, Nitric provides prefixed Environment Variables, which you can find in the table below.
 
-| Name               | Description                                                                                                                                                                                                                   |
-| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| NITRIC_STACK_ID    | The Stack ID of the project. Example: `coolkat-gcp-4c0wg0hg`                                                                                                                                                                  |
-| NITRIC_ENVIRONMENT | The Environment that the app is running on. The value can be either `cloud` (for deployed in the cloud), `run` (for stacks running in nitric run), or `build` (for stack code running during the deployment gathering phase). |
+| Name               | Description                                                                                                       |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------- |
+| NITRIC_STACK_ID    | The unique identifier for your deployed stack (e.g., `coolkat-gcp-4c0wg0hg`)                                      |
+| NITRIC_ENVIRONMENT | The environment where the app is running: `cloud` (deployed), `run` (local stack), or `build` (during deployment) |
 
 ## Application Environment Variables
 

docs/reference/nodejs/secrets/secret-put.mdx

@@ -40,7 +40,12 @@ import { secret } from '@nitric/sdk'
 
 const keyRef = secret('apiKey').allow('put')
 
-await keyRef.put('6c3199a3-094e-4797-bfc9-9ee2a7839286')
+try {
+  await keyRef.put('6c3199a3-094e-4797-bfc9-9ee2a7839286')
+  console.log('Secret value stored successfully')
+} catch (error) {
+  console.error('Error storing secret value:', error)
+}
 ```
 
 ### Get the id of a new secret version
@@ -52,9 +57,10 @@ import { secret } from '@nitric/sdk'
 
 const keyRef = secret('apiKey').allow('put')
 
-const newApiKeyVersionRef = await keyRef.put(
-  '6c3199a3-094e-4797-bfc9-9ee2a7839286',
-)
-
-const versionId = newApiKeyVersionRef.version
+try {
+  const newVersion = await keyRef.put('6c3199a3-094e-4797-bfc9-9ee2a7839286')
+  console.log('New secret version created:', newVersion.version)
+} catch (error) {
+  console.error('Error creating new secret version:', error)
+}
 ```

docs/reference/nodejs/sql/sql-connection-string.mdx

@@ -30,7 +30,12 @@ import { sql } from '@nitric/sdk'
 const db = sql('my-data')
 
 // Should be called at runtime, such as in a service handler
-const connStr = await db.connectionString()
+try {
+  const connStr = await db.connectionString()
+  console.log('Database connection string:', connStr)
+} catch (error) {
+  console.error('Error getting connection string:', error)
+}
 ```
 
 ### Connect with Prisma

docs/reference/nodejs/storage/bucket-file-read.mdx

@@ -32,5 +32,10 @@ const assets = bucket('assets').allow('read')
 
 const logo = assets.file('images/logo.png')
 
-const logoData = await logo.read()
+try {
+  const logoData = await logo.read()
+  console.log('Logo data:', logoData)
+} catch (error) {
+  console.error('Error reading logo:', error)
+}
 ```

docs/reference/nodejs/storage/bucket-file-write.mdx

@@ -17,8 +17,16 @@ import { bucket } from '@nitric/sdk'
 const assets = bucket('assets').allow('write')
 
 const logo = assets.file('images/logo.png')
-
-await logo.write(someImageData)
+const imageData = new Uint8Array([
+  /* image data */
+])
+
+try {
+  await logo.write(imageData)
+  console.log('Logo written successfully')
+} catch (error) {
+  console.error('Error writing logo:', error)
+}
 ```
 
 ## Parameters
@@ -41,5 +49,10 @@ const assets = bucket('assets').allow('write')
 const txt = assets.file('my-text-file.txt')
 const buffer = Buffer.from('My Test File...')
 
-await txt.write(buffer)
+try {
+  await txt.write(buffer)
+  console.log('Text file written successfully')
+} catch (error) {
+  console.error('Error writing text file:', error)
+}
 ```

docs/reference/nodejs/storage/bucket-on.mdx

@@ -29,9 +29,12 @@ assets.on('write', '/images/cat', (ctx) => {
 
 // If `on` is called with a permissioned bucket, a file will also be provided with the request
 accessibleAssets.on('write', '/images/dog', async (ctx) => {
-  const dogImage = await ctx.req.file.read()
-
-  console.log(dogImage)
+  try {
+    const dogImage = await ctx.req.file.read()
+    console.log(dogImage)
+  } catch (error) {
+    console.error('Error reading dog image:', error)
+  }
 })
 ```
 

docs/reference/nodejs/websocket/websocket-on.mdx

@@ -78,8 +78,13 @@ const socket = websocket('socket')
 const connections = kv('connections').allow('get', 'set', 'delete')
 
 socket.on('connect', async (ctx) => {
-  const connectionList = await connections.get('connections')
-  await connections..set('connections', [
+  let connectionList = []
+  try {
+    connectionList = await connections.get('connections')
+  } catch (e) {
+    console.log('Creating new connections store')
+  }
+  await connections.set('connections', [
     ...connectionList,
     {
       // store any metadata related to the connection here
@@ -89,10 +94,16 @@ socket.on('connect', async (ctx) => {
 })
 
 socket.on('disconnect', async (ctx) => {
-  const connectionList = await connections.get('connections')
+  let connectionList = []
+  try {
+    connectionList = await connections.get('connections')
+  } catch (e) {
+    console.log('No connections found')
+    return
+  }
   await connections.set(
     'connections',
-    connectionList.filter((c) => c.connectionId === ctx.req.connectionId)
+    connectionList.filter((c) => c.connectionId === ctx.req.connectionId),
   )
 })
 ```

docs/reference/nodejs/websocket/websocket-send.mdx

@@ -77,7 +77,13 @@ socket.on('disconnect', async (ctx) => {
 })
 
 const broadcast = async (data) => {
-  const conns = await connections.get('connections')
+  let conns = {}
+  try {
+    conns = await connections.get('connections')
+  } catch (e) {
+    console.log('No connections found')
+    return
+  }
 
   await Promise.all(
     Object.keys(conns).map(async (connectionId) => {