Merge branch 'pocketnetteam:main' into main

.github/workflows/deploy.yml

@@ -34,13 +34,33 @@ jobs:
           path: assets/
           retention-days: 1
 
+  build_vue:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Build
+        run: |
+          cd ./vuepress-starter/
+          npm i
+          npm run docs:build
+      - name: Save Artifact Build
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: ./vuepress-starter/docs/.vuepress/dist/
+          retention-days: 1
+
   deploy_win:
     runs-on: docs-en-deploy
     needs: build
     steps:
       - name: Download artifacts
         uses: actions/download-artifact@v3
-
       - name: Copy artifacts
         run: |
           cp -Recurse -Force ./build/site/* c:/inetpub/wwwroot/docs/en/
@@ -52,8 +72,18 @@ jobs:
     steps:
       - name: Download artifacts
         uses: actions/download-artifact@v3
-
       - name: Copy artifacts
         run: |
           cp -r ./build/site/* /data/docs/en/
           cp -r ./assets/* /data/docs/
+
+  deploy_docs_pocketnet_app:
+    runs-on: docs.bastyon.com
+    needs: build_vue
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+      - name: Copy artifacts
+        run: |
+          rm -rf /data/documentation/*
+          cp -r ./dist/* /data/documentation/

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "grammarly.selectors": [
+        {
+            "language": "markdown",
+            "scheme": "file"
+        }
+    ]
+}

documentation-approach-en.md

@@ -1,9 +1,5 @@
 The plan for Developer's Guide
-AI Prompts:
-I am trying to design a documentation strategy for Bastyon. I am a volunteer there who wants to help the project to move forward.
-The project is called Bastyon. It's a decentralized social platform with a messenger. It also wants to build an API set around building miniapps on Bastyon. Its source code is located at https://github.com/pocketnetteam
-The documentation is needed for app usage and developer documentation.
-What I need help with a vision for documentation, roadmap and concrete documentation design that adheres with the theory of information and other theoretical work around documentation design.
+
 
 ### Motivation
 

vuepress-starter/.github/workflows/deploy-docs.yml

@@ -0,0 +1,47 @@
+
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      # make sure this is the branch you are using
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Deps
+        run: npm ci
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          npm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # This is the branch where the docs are deployed to
+          branch: gh-pages
+          folder: docs/.vuepress/dist

vuepress-starter/.gitignore

@@ -0,0 +1 @@
+**/dist

vuepress-starter/docs/.vuepress/.gitignore

@@ -0,0 +1,3 @@
+.cache
+.temp
+dist

vuepress-starter/docs/.vuepress/config.js

@@ -0,0 +1,28 @@
+import { defaultTheme } from '@vuepress/theme-default'
+import { defineUserConfig } from 'vuepress/cli'
+import { viteBundler } from '@vuepress/bundler-vite'
+
+export default defineUserConfig({
+  lang: 'en-US',
+  title: ' ',  
+  description: 'This documentation will help you get started with Bastyon.',
+
+  theme: defaultTheme({
+    logo: '/bastyon-logo-32x32.png',
+
+    navbar: ['/', '/get-started'],
+  }),
+  plugins: [
+    [
+      'vuepress-plugin-mathjax',
+      {
+        target: 'svg',
+        macros: {
+          '*': '\\times',
+        },
+      },
+    ],
+  ],
+
+  bundler: viteBundler(),
+})

vuepress-starter/docs/README.md

@@ -0,0 +1,30 @@
+---
+home: true
+title: Home
+heroImage: /bastyon-logo-256x256.png
+actions:
+  - text: Developer Documentation
+    link: /en/dev-docs/get-started-dev.md
+    type: primary
+
+  - text: Monetize With Bastyon
+    link: /en/user-docs/get-started-user.md
+    type: primary
+
+features:
+  - title: Freedom of Expression
+    details: The platform operates without a central authority, making it resistant to traditional censorship methods.
+  - title: Diverse Content Sharing
+    details: Users can post a variety of content including text, videos, and long-form blogs with minimal restrictions.
+  - title: Earn Cryptocurrency
+    details: Users can monetize their content and interactions using PKOIN, Bastyon's native cryptocurrency.
+  - title: Enhanced Privacy
+    details: Users can interact on the platform without concerns about their personal data being collected or sold. 
+  - title: Trusted Content Storage
+    details: Users benefit from decentralized technology ensuring their content remains unaltered and accessible.
+  - title: Flexible Access
+    details: Bastyon is available on iOS, Android, as a desktop app, and as a web app via web most web browsers.
+
+
+footer: Apache License-2.0 | Copyright © 2019-present Bastyon
+---

vuepress-starter/docs/en/user-docs/advertisement-cpm-calculation.md

@@ -0,0 +1,54 @@
+# CPM Derivation
+
+
+Bastyon has about 1.63 MILLION unique visitors a month. Average visitor visits 5 times per month, and English language feed is 10% of Bastyon, so TOTAL NUMBER OF MONTHLY VISITS = 1.65M * 10% * 5 = 815,000.<sup>1</sup>
+
+1.63M visits are distributed across various platforms:
+
+| Platform <sup>2</sup>      | Users   |
+|------------------|---------|
+| Bastyon.com      | 1.4M    |
+| Android          | 130k    |
+| Desktop app      | 100k    |  
+
+
+### Bastyon.com Usage
+
+1.4M is on Bastyon.com (SEMRUSH data)
+
+![alt text](semrush-bastyon-data.png)
+
+### Desktop App Usage
+
+Number of desktop app users is 150,000+.<sup>3</sup>
+
+[![alt text](bastyon-desktop-browser.png)](https://github.com/pocketnetteam/pocketnet.gui)
+
+### Android Usage
+
+Number of active android users is 130,000+
+
+
+### iOS Usage
+
+<!--- todo --->
+
+
+### CPM Calculation
+
+1. Every boost ad runs for 3 hours. So, we divide total monthly visits by 30 days and by 8 to get 3-hour intervals
+2. Total monthly visits = 815 thousand
+3. Total daily visits = 27,100
+4. English feed has 10% of all visitors
+5. Total visits in 3 hour interval = 27,100/8 = 3395
+6. Average cost of ad is $1
+7. CPM = $. 29
+8. 29 cents on average is a very low CPM
+
+***
+
+<sup>1</sup>Based on December 2022 data.
+
+<sup>2</sup> iOS was not initially included in the calculations
+
+<sup>3</sup> After every app update users gradually update desktop app, approx. Half of users updates one week after update. The image shows that 76 thousand users updated their apps immediately on day one, only half of the people update so quickly, so the real number is 150k users approximately

vuepress-starter/docs/en/user-docs/buying-pkoin.md

@@ -0,0 +1,34 @@
+# Buying PKOIN
+
+PKOIN is the native cryptocurrency of the Bastyon platform. It serves as the economic backbone of the ecosystem, enabling users to monetize their content and interactions. Users can earn PKOIN through various activities on the platform, such as creating popular posts, receiving likes, being the node-runners.
+
+PKOIN can be used for:
+1. Tipping content creators
+2. Boosting posts for increased visibility
+3. Accessing premium features on the platform
+4. Trading with other cryptocurrencies or fiat currencies
+
+To acquire PKOIN, users have several options:
+
+1. Private parties: Users can arrange peer-to-peer transactions with other PKOIN holders through secure messaging channels or community forums.
+
+2. Exchange services: Cryptocurrency exchange services may offer PKOIN trading pairs.
+
+
+## Buying PKOIN on Exchanges and Exchange Services
+
+PKOIN can be purchased on the following sites.
+
+[![Alt text](tapbit.png)](Tapbit.com)
+
+[![alt text](Digifinex.png)](Digifinex.com)
+
+
+[PKOIN.NET](https://pkoin.net)
+
+
+## Buying PKOIN peer-to-peer on Bastyon
+
+You can also purchase PKOIN from other Bastyon users. You can agree on the terms of purchase/sale in personal correspondence with the seller / buyer, whom you can find in the news feed under the **PKOIN/peer-to-peer** category.
+
+![alt text](buying-pkoin-from-private-party.png)