Docs tweaks

TooTallNate · Jul 17, 2024 · 5e0c227 · 5e0c227
1 parent 3816ccc
commit 5e0c227
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/docs/content/runtime/concepts/albums.mdx b/docs/content/runtime/concepts/albums.mdx
@@ -1,5 +1,5 @@
 ---
-title: Photo Albums
+title: Albums
 description: Working with the screenshot / video albums
 ---
 

diff --git a/docs/content/runtime/concepts/file-system.mdx b/docs/content/runtime/concepts/file-system.mdx
@@ -28,7 +28,7 @@ instances of `Switch.FsFile`.
 
 ### Read as JSON
 
-Reading and parsing a JSON file is a one-liner:
+Reading and parsing a JSON file is a one-liner via the [`json()`](/runtime/api/namespaces/Switch/classes/FsFile#json) function:
 
 ```typescript
 const topScores = await Switch.file('sdmc:/top-scores.json').json();
@@ -37,8 +37,8 @@ console.log(topScores);
 
 ### Readable stream
 
-`Switch.FsFile` allows you to read a file using the web ReadableStream API, by invoking the `stream()`
-function which returns a ReadableStream instance:
+To read a file using the [Web Streams API](https://developer.mozilla.org/docs/Web/API/Streams_API), invoke the [`stream()`](/runtime/api/namespaces/Switch/classes/FsFile#stream)
+function which returns a [`ReadableStream`](/runtime/api/classes/ReadableStream) instance:
 
 ```typescript
 for await (const chunk of Switch.file('sdmc:/data.txt').stream()) {

diff --git a/docs/content/runtime/concepts/profiles.mdx b/docs/content/runtime/concepts/profiles.mdx
@@ -1,5 +1,5 @@
 ---
-title: User Profiles
+title: Profiles
 description: Interacting with user profiles
 ---
 
@@ -20,6 +20,7 @@ You may _set_ the `Switch.Profile.current` property to force the "current" profi
 the specified profile. Doing so will prevent the user selection modal from being
 shown when accessing [`localStorage`](/runtime/api/variables/localStorage).
 
+> [!NOTE]
 > The `localStorage` API utilizes this value to determine which user profile to associate the data with.
 
 
@@ -40,7 +41,8 @@ if (profile) {
 }
 ```
 
-> The user selection modal is _synchronous_, so it will __block the application event loop__
+> [!WARNING]
+> The user selection modal is _synchronous_, so it will __block the event loop__
 > until the user selects a profile.
 
 ## Iterate user profiles

diff --git a/docs/content/runtime/rendering/canvas.mdx b/docs/content/runtime/rendering/canvas.mdx
@@ -10,6 +10,7 @@ to draw to the screen.
 The global `screen` object is used to create a `CanvasRenderingContext2D`
 instance, at which point the app is in __canvas rendering__ mode.
 
+> [!IMPORTANT]
 > You should avoid using any `console` printing functions when in __canvas rendering__ mode.
 > Doing so will change the app back to [__console rendering__](/runtime/rendering/console) mode.
 

diff --git a/docs/content/runtime/rendering/console.mdx b/docs/content/runtime/rendering/console.mdx
@@ -4,10 +4,11 @@ description: Logging to the Console for text based applications
 ---
 
 If your application is purely text-based, you can use the familiar
-`console` global to write textual data to the screen of the application
+global `console` object to write textual data to the screen of the application
 in the terminal-like interface that [`libnx`](https://github.com/switchbrew/libnx) provides.
 
-> To draw more intricate graphics, you should use the [Canvas API](/runtime/rendering/canvas).
+> [!TIP]
+> To draw more intricate graphics, you should use [__canvas rendering__](/runtime/rendering/canvas) mode.
 
 ## Example
 
@@ -17,7 +18,7 @@ console.log('Hello World');
 
 ## ANSI Escape Codes
 
-Listed below is a (non-exhaustive) list of npm modules known to work well with nx.js when using the Console renderer:
+Listed below is a (non-exhaustive) list of npm modules known to work well with nx.js when using console rendering mode:
 
 * [`kluer`](https://github.com/lukeed/kleur) - Output colored text with ANSI escape codes
 * [`sisteransi`](https://github.com/terkelg/sisteransi) - ANSI escape sequences for moving the cursor