Update documentation

danielsaidi · Mar 6, 2024 · 1c86ddc · 1c86ddc
1 parent 99d4306
commit 1c86ddc
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/Sources/RichTextKit/RichTextKit.docc/Articles/Context-Article.md b/Sources/RichTextKit/RichTextKit.docc/Articles/Context-Article.md
@@ -7,7 +7,7 @@ This article describes how to use the ``RichTextContext`` to observe and modify
     @PageImage(
         purpose: card,
         source: "Page",
-        alt: "RichTextKit page icon"
+        alt: "Page icon"
     )
 
     @PageColor(blue)

diff --git a/Sources/RichTextKit/RichTextKit.docc/Articles/Demo-Article.md b/Sources/RichTextKit/RichTextKit.docc/Articles/Demo-Article.md
@@ -1,6 +1,6 @@
 # Demo App
 
-This article describes the RichTextKit demo app & where to find it.
+This article describes how to try the RichTextKit demo app.
 
 @Metadata {
 
@@ -11,7 +11,7 @@ This article describes the RichTextKit demo app & where to find it.
     @PageImage(
         purpose: card,
         source: "Page",
-        alt: "RichTextKit page icon"
+        alt: "Page icon"
     )
 }
 

diff --git a/Sources/RichTextKit/RichTextKit.docc/Articles/Format-Article.md b/Sources/RichTextKit/RichTextKit.docc/Articles/Format-Article.md
@@ -7,7 +7,7 @@ This article describes the various ``RichTextDataFormat``s that are supported by
     @PageImage(
         purpose: card,
         source: "Page",
-        alt: "RichTextKit page icon"
+        alt: "Page icon"
     )
 
     @PageColor(blue)

diff --git a/Sources/RichTextKit/RichTextKit.docc/Articles/Views-Article.md b/Sources/RichTextKit/RichTextKit.docc/Articles/Views-Article.md
@@ -7,7 +7,7 @@ This article describes the RichTextKit view library.
     @PageImage(
         purpose: card,
         source: "Page",
-        alt: "RichTextKit page icon"
+        alt: "Page icon"
     )
 
     @PageColor(blue)

diff --git a/...chTextKit.docc/Getting-Started-Article.md → ...xtKit/RichTextKit.docc/Getting-Started.md b/...chTextKit.docc/Getting-Started-Article.md → ...xtKit/RichTextKit.docc/Getting-Started.md
@@ -75,14 +75,13 @@ When using RichTextKit in SwiftUI, you should however only have to care about th
 
 
 
-
-## RichTextContext
+## Context
 
 The ``RichTextContext`` is at the heart of the ``RichTextEditor``. See the <doc:Context-Article> article for more information on how to use it to observe and change any rich text properties in your text editor.
 
 
 
-## RichTextDataFormat
+## Data Formats
 
 In RichTextKit, a ``RichTextDataFormat`` determines how rich text content is handled and persisted. See the <doc:Format-Article> article for more information on how to use different data formats.
 
@@ -94,7 +93,7 @@ There are many different SwiftUI views within the library besides the ``RichText
 
 
 
-## Read More
+## Further Reading
 
 @Links(visualStyle: detailedGrid) {
 

diff --git a/Sources/RichTextKit/RichTextKit.docc/RichTextKit.md b/Sources/RichTextKit/RichTextKit.docc/RichTextKit.md
@@ -25,13 +25,11 @@ https://github.com/danielsaidi/RichTextKit.git
 
 
 
-## Getting Started
-
-RichTextKit is easy to get started with.
+## Getting started
 
 @Links(visualStyle: detailedGrid) {
 
-    - <doc:Getting-Started-Article>
+    - <doc:Getting-Started>
     - <doc:Demo-Article>
 }
 
@@ -51,9 +49,12 @@ RichTextKit is available under the MIT license.
 
 ## Topics
 
-### Articles
+### Getting Started
 
 - <doc:Getting-Started>
+
+### Articles
+
 - <doc:Demo-Article>
 - <doc:Context-Article>
 - <doc:Format-Article>