Merge pull request #28 from Yinnerston/doc-theming-and-context

Doc theming and context

README.md

@@ -4,3 +4,12 @@ Reverse engineering TikTok.
 Documentation is on https://yinnerston.github.io/Teaser/
 
 Official Site: https://teasernsfw.com
+
+### Contact me
+I am broke and looking for a job as a junior or intern full-stack software engineer. 
+I'm industrious, and ambitious and I want to work on ambitious things with others. 
+Forwarding me jobs or referrals is greatly appreciated!
+
+Contact:
+- [email protected]
+- https://github.com/sponsors/Yinnerston

docs/Teaser/docs/explaination/01_scalability_strategy.md

@@ -7,7 +7,7 @@ sidebar_label: "Scalability Strategy"
 
 **In-Depth strategy:** https://docs.google.com/document/d/1RnDb1ep0ZLi6Y_Ep7Bzz1ufI4fIPGH7e9RaIzvJu0kg/edit?usp=sharing
 
-![System Design Primer](./images/systemdesignprimer.png)
+![System Design Primer](/docs/img/systemdesignprimer.png)
 
 :::tip Low hanging fruits
 Exhaust the low-hanging fruits of vertical scaling before attempting a horizontal scaling strategy

docs/Teaser/docs/getting-started/01_introduction.md

@@ -7,6 +7,6 @@ sidebar_label: 'Introduction'
 
 | Image | Source Code   |
 | ---   | ---   |
-| ![Main Feed](./images/camerathumb.jpg) | Main feed mainly relates to `src/frontend/teaser/components/templates/TeaserViewList.js`in the frontend and `src/backend/teaser/core/services/post_service.py` in the backend.   |
-| ![Video Editor](./images/editthumb.jpg) | The video editing screen can be found at `src/frontend/teaser/screens/upload/UploadEditVideoScreen.js`. Video pre-processing such as concatenation and adding music will be done on the frontend.   |
+| ![Main Feed](/docs/img/camerathumb.jpg) | Main feed mainly relates to `src/frontend/teaser/components/templates/TeaserViewList.js`in the frontend and `src/backend/teaser/core/services/post_service.py` in the backend.   |
+| ![Video Editor](/docs/img/editthumb.jpg) | The video editing screen can be found at `src/frontend/teaser/screens/upload/UploadEditVideoScreen.js`. Video pre-processing such as concatenation and adding music will be done on the frontend.   |
 | **TODO**    | More coming soon.    |

docs/Teaser/docs/getting-started/04_data_model.md

@@ -6,7 +6,7 @@ sidebar_label: "Data Model"
 # Data Model
 
 Open the SVG in a new tab to enlarge it.
-![SVG Data Model](./assets/er-data-model.svg)
+![SVG Data Model](/docs/assets/er-data-model.svg)
 
 As mermaid inline:
 ```mermaid

docs/Teaser/docs/intro.md

@@ -9,27 +9,33 @@ I want to reverse engineer TikTok, so I made Teaser.
 
 # What is the vision?
 
+### Teaser as of 18/06/2023:
+![Teaser Mind Map SVG](/docs/img/teasermindmap.svg)
+
 - Video editor
   - Video filters
   - Cutting and splicing video together
   - Adding music from youtube clips
-  - In app browser
-- Recommendation algorithm
+  - **TODO:** In app browser like HN Harmonic & video download
+- **TODO:** Recommendation algorithm
 - User profiles
   - Profile photos
-  - Follow other users
-  - Save posts to view later
+  - **TODO:** Follow other users
+  - **TODO:** Save posts to view later
 - Tagging system
   - Teasers are searchable by tags
   - Robust tagging system
+  - **TODO:** Link tags when clicked to search results
 - Teaser video viewer
   - Likes, profile view, share, comments, etc
-- Chat client
-  - Group chat with XMPP client
-  - 1:1 chat with subscribers
-- Content moderation
+  - **TODO:** Nested comments
+- **TODO:** XMPP Chat client
+  - Prosody Server + Converse.js headless client
+  - Message encryption
+  - Group chat, 1:1 chat with subscribers
+- **TODO:** Content moderation
   - NO illegal content! (See our terms of use)
-- Payments
+- **TODO:** Payments
   - Stripe API
 
 # What is NOT in scope?

docs/Teaser/docusaurus.config.js

@@ -66,12 +66,12 @@ const config = {
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       // Replace with your project's social card
-      image: "img/docusaurus-social-card.jpg",
+      image: "img/Teaser-social-card.jpg",
       navbar: {
         title: "Teaser",
         logo: {
           alt: "Teaser Logo",
-          src: "img/logo.svg",
+          src: "img/favicon.ico",
         },
         items: [
           {
@@ -95,25 +95,25 @@ const config = {
             title: "Docs",
             items: [
               {
-                label: "Tutorial",
+                label: "Introduction",
                 to: "/docs/intro",
               },
+              {
+                label: "API",
+                href: "https://wocchit.com/api/v1/docs",
+              },
             ],
           },
           {
             title: "Community",
             items: [
               {
-                label: "Stack Overflow",
-                href: "https://stackoverflow.com/questions/tagged/docusaurus",
-              },
-              {
-                label: "Discord",
-                href: "https://discordapp.com/invite/docusaurus",
+                label: "Jira",
+                href: "https://memefeed.atlassian.net/jira/software/projects/TSR/boards/6",
               },
               {
-                label: "Twitter",
-                href: "https://twitter.com/docusaurus",
+                label: "Email",
+                href: "mailto:teaseradmin@teasernsfw.com",
               },
             ],
           },
@@ -124,6 +124,10 @@ const config = {
                 label: "Blog",
                 to: "/blog",
               },
+              {
+                label: "Official Website",
+                href: "https://teasernsfw.com",
+              },
               {
                 label: "GitHub",
                 href: "https://github.com/Yinnerston/Teaser",

docs/Teaser/src/components/HomepageFeatures/index.js

@@ -4,32 +4,38 @@ import styles from "./styles.module.css";
 
 const FeatureList = [
   {
-    title: "Easy to Use",
+    title: "Free and Open Source",
     Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default,
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        Teaser is free to host and is now fully open-source! I'm still studying
+        at university but I want to work on Teaser with others in my spare time.
       </>
     ),
   },
   {
-    title: "Focus on What Matters",
+    title: "Made to Teach Others",
     Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default,
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        I want to use this project to share my knowledge, to work
+        collaboratively and to build a better social media platform. Maybe we
+        can address the{" "}
+        <a href="https://www.wired.com/story/tiktok-platforms-cory-doctorow/">
+          enshittification
+        </a>{" "}
+        of TikTok?
       </>
     ),
   },
   {
-    title: "Powered by React",
+    title: "Django Ninja and React Native",
     Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+        I'm using a pretty common and accessible stack for web developers. I
+        hope the combination of strong documentation and powerful tools aids
+        development.
       </>
     ),
   },