Minor documentation review updates (#388)

- From #346 comments - Fixing issues with deployment: https://github.com/ProjectLibertyLabs/gateway/actions/runs/10404141334
ProjectLibertyLabs · Aug 15, 2024 · 4ba0971 · 4ba0971
1 parent 6080700
commit 4ba0971
Show file tree

Hide file tree

Showing 18 changed files with 17 additions and 71 deletions.
diff --git a/.github/workflows/deploy-gh-pages.yaml b/.github/workflows/deploy-gh-pages.yaml
@@ -39,7 +39,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: mdbook
-          path: ./docs
+          path: ./docs/book
 
   build:
     runs-on: ubuntu-latest
@@ -76,19 +76,12 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
       - name: Download mdbook artifact
         uses: actions/download-artifact@v4
         with:
           name: mdbook
           path: ./docs
 
-      - name: Move mdbook to root
-        run: mv ./docs/book/* ./docs
-        shell: bash
-
       - name: Download account OpenAPI artifacts
         uses: actions/download-artifact@v4
         with:

diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@
 
 # 📖 Gateway Services <a name="about-project"></a>
 
-Gateway is a collection of services that helps make interacting with Frequency as easy as working with any web2 API!
+Gateway is a collection of services that helps make interacting with Frequency as easy as working with any Web2 API!
 
 <!-- Mermaid Arch maps -->
 

diff --git a/docs/src/BestPractices/README.md b/docs/src/BestPractices/README.md
diff --git a/docs/src/BestPractices/Scalability.md b/docs/src/BestPractices/Scalability.md
diff --git a/docs/src/CHANGELOG.md b/docs/src/CHANGELOG.md
diff --git a/docs/src/CONTRIBUTING.md b/docs/src/CONTRIBUTING.md
diff --git a/docs/src/Fundamentals/BlockchainBasics.md b/docs/src/Fundamentals/BlockchainBasics.md
@@ -46,7 +46,7 @@ Blockchain technology is a decentralized ledger system where data is stored acro
 
 Frequency enables seamless interaction and data sharing between different social dapps built on its platform. This interoperability is facilitated by:
 
-- **Standardized Protocols:** Frequency uses the Decentralized Social Networking Protocol (DSNP), an open web3 protocol that ensures compatibility between different social dapps.
+- **Standardized Protocols:** Frequency uses the Decentralized Social Networking Protocol (DSNP), an open Web3 protocol that ensures compatibility between different social dapps.
 - **Common Data Structures:** By using standardized data structures for user profiles, messages, and other social interactions, Frequency ensures that data can be easily shared and interpreted across different applications.
 - **Interoperable APIs:** Frequency provides a set of REST APIs that allow developers to build applications capable of interacting with each other, ensuring a cohesive user experience across the ecosystem.
 - **User Control:** Users can switch between different social dapps without losing their social connections or content, ensuring continuity and control over their digital presence.

diff --git a/docs/src/Fundamentals/README.md b/docs/src/Fundamentals/README.md
@@ -4,8 +4,8 @@
 
 ## Global State
 
-Frequency is a shared global state to make interoperability and user control fundamental to the internet.
-Applications provide unique experiences to their users while accessing the greater public content and graph connections from other applications.
+Frequency provides a shared global state to make interoperability and user control fundamental to the internet.
+Applications provide unique experiences to their users while accessing the content and graph connections from other applications.
 Just like how the internet is a shared global network, your applications can break out of their artificial boundaries.
 
 ## User Control with Delegation
@@ -20,9 +20,8 @@ Learn more about Delegation in [Frequency Documentation](https://docs.frequency.
 Frequency enables seamless interaction and data sharing between different applications built on its platform.
 This interoperability is facilitated by:
 
-- **Standardized Protocols:** Frequency uses the Decentralized Social Networking Protocol (DSNP), an open web3 protocol that ensures compatibility between different applications.
+- **Standardized Protocols:** Frequency uses the Decentralized Social Networking Protocol (DSNP), an open Web3 protocol that ensures compatibility between different applications.
 - **Common Data Structures:** By using standardized data structures for user profiles, messages, and other social interactions, Frequency ensures that data can be easily shared and interpreted across different applications.
-- **Interoperable APIs:** Frequency provides a set of REST APIs that allow developers to build applications capable of interacting with each other, ensuring a cohesive user experience across the ecosystem.
 - **User Control:** Users can switch between different applications without losing their social connections or content, ensuring continuity and control over their digital presence.
 
 By leveraging these principles and infrastructures, Frequency provides a robust platform for developing decentralized social applications that are secure, scalable, and user-centric.

diff --git a/docs/src/GettingStarted/README.md b/docs/src/GettingStarted/README.md
@@ -56,7 +56,7 @@ git clone https://github.com/ProjectLibertyLabs/social-app-template.git
 ```
 
 ```sh
-cd social-web-template
+cd social-app-template
 ```
 
 ### Run the Configuration Script

diff --git a/docs/src/Glossary.md b/docs/src/Glossary.md
diff --git a/docs/src/Integration/BuildingApps.md b/docs/src/Integration/BuildingApps.md
diff --git a/docs/src/Integration/README.md b/docs/src/Integration/README.md
diff --git a/docs/src/NextSteps/README.md b/docs/src/NextSteps/README.md
diff --git a/docs/src/NextSteps/Tutorial.md b/docs/src/NextSteps/Tutorial.md
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -1,16 +1,16 @@
 # Making Decentrialized Social Easy
 
-Get started using Decentralized Social as easy as deploying a web2 API.
+Get started building on Decentralized Social as easy as deploying a Web2 API.
 
 ## Build What You Want
 
 Gateway offers a suite of tools you can pick and choose to build the best for your users.
 
 <!-- Add more visual elements to the services -->
 
-- Identity
-- Graph
-- Content
+- Add decentralized authentication and onboarding workflows
+- Connect your users with their universal social graph
+- Read, write, and interact with social media content
 - More coming...
 
 ## Web2 API Simplicity with Decentralized Power
@@ -22,7 +22,7 @@ Gateway offers a suite of tools you can pick and choose to build the best for yo
 
 ## Basic Architecture
 
-Gateway provides easy way to interact with Frequency without requiring any direct chain interactions.
+Gateway provides a simple API to interact with the Frequency social layers of identity, graph, content, and more.
 
 ![Gateway Application Layer Diagram](./gateway_arch-Layer.drawio.png)
 
@@ -38,14 +38,14 @@ These microservices are 100% independent of each other, so use only what you wan
 Account Service is a service enabling easy interaction with accounts on Frequency.
 Accounts are be defined as an `msaId` (a 64 bit identifier) and can contain additional information such as a handle, keys, and more.
 
-- Account creation using [SIWF](https://github.com/ProjectLibertyLabs/siwf)
+- Account authentication and creation using [SIWF](https://github.com/ProjectLibertyLabs/siwf)
 - Delegation management
 - User Handle creation and retrieval
 - User key retrieval and management
 
 ### Graph Service
 
-The Graph Service is a service enabling easy interaction with graphs on Frequency.
+The Graph Service is a service enabling easy interaction with social graphs on Frequency.
 Each Graph connection on Frequency can be private or public and can be unidirectional (a follow) or bidiectional (double opt-in friend connection).
 
 - Fetch user graph
@@ -61,7 +61,7 @@ The Content Publishing Service is a service enabling the creation of new content
 - Create reactions to posts
 - Create updates to existing content
 - Request deletion of content
-- Asset creation with [IPFS](https://ipfs.tech)
+- Media attachement storage with [IPFS](https://ipfs.tech)
 
 ### Content Watcher Service
 

diff --git a/docs/src/Tools/README.md b/docs/src/Tools/README.md
diff --git a/services/content-publishing/README.md b/services/content-publishing/README.md
@@ -31,7 +31,7 @@
 
 # 📖 Content Publishing Service <a name="about-project"></a>
 
-The Content Publishing Service is part of the "Social Gateway" collection of services that provides a familiar REST API to allow uploading content and publishing announcements to the Frequency chain. The service handles all of the necessary blockchain interaction and allows clients to interact using a familiar, web2-friendly interface.
+The Content Publishing Service is part of the "Social Gateway" collection of services that provides a familiar REST API to allow uploading content and publishing announcements to the Frequency chain. The service handles all of the necessary blockchain interaction and allows clients to interact using a familiar, Web2-friendly interface.
 
 <!-- Arch maps -->
 

diff --git a/services/content-watcher/README.md b/services/content-watcher/README.md
@@ -31,7 +31,7 @@
 
 # 📖 Content Watcher Service <a name="about-project"></a>
 
-The Content Watcher Service is part of the "Social Gateway" collection of services that provides a familiar callback API to retrieve content and publishing announcements from the Frequency chain. The service handles all of the necessary blockchain interaction and allows clients to interact using a familiar, web2-friendly interface.
+The Content Watcher Service is part of the "Social Gateway" collection of services that provides a familiar callback API to retrieve content and publishing announcements from the Frequency chain. The service handles all of the necessary blockchain interaction and allows clients to interact using a familiar, Web2-friendly interface.
 
 <!-- Arch maps -->