Skip to content

Commit

Permalink
reducing the PR to just having home page and Get Started section
Browse files Browse the repository at this point in the history
  • Loading branch information
gked committed Oct 13, 2024
1 parent 0a825a5 commit a347211
Show file tree
Hide file tree
Showing 36 changed files with 106 additions and 259 deletions.
21 changes: 0 additions & 21 deletions vuepress-starter/docs/.vuepress/.temp/internal/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,5 @@ export const redirects = JSON.parse("{}")
export const routes = Object.fromEntries([
["/", { loader: () => import(/* webpackChunkName: "index.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/index.html.js"), meta: {"title":"Home"} }],
["/get-started.html", { loader: () => import(/* webpackChunkName: "get-started.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/get-started.html.js"), meta: {"title":"Get Started"} }],
["/en/dev-docs/get-started-dev.html", { loader: () => import(/* webpackChunkName: "en_dev-docs_get-started-dev.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/dev-docs/get-started-dev.html.js"), meta: {"title":"Developer Documentation"} }],
["/en/user-docs/advertisement-cpm-calculation.html", { loader: () => import(/* webpackChunkName: "en_user-docs_advertisement-cpm-calculation.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/user-docs/advertisement-cpm-calculation.html.js"), meta: {"title":"CPM Derivation"} }],
["/en/user-docs/get-started-user.html", { loader: () => import(/* webpackChunkName: "en_user-docs_get-started-user.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/user-docs/get-started-user.html.js"), meta: {"title":"Ways to Monetize"} }],
["/404.html", { loader: () => import(/* webpackChunkName: "404.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/404.html.js"), meta: {"title":""} }],
["/en/user-docs/buying-pkoin.html", { loader: () => import(/* webpackChunkName: "en_user-docs_buying-pkoin.html" */"/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/user-docs/buying-pkoin.html.js"), meta: {"title":"Buying PKOIN"} }],
]);

if (import.meta.webpackHot) {
import.meta.webpackHot.accept()
if (__VUE_HMR_RUNTIME__.updateRoutes) {
__VUE_HMR_RUNTIME__.updateRoutes(routes)
}
if (__VUE_HMR_RUNTIME__.updateRedirects) {
__VUE_HMR_RUNTIME__.updateRedirects(redirects)
}
}

if (import.meta.hot) {
import.meta.hot.accept(({ routes, redirects }) => {
__VUE_HMR_RUNTIME__.updateRoutes(routes)
__VUE_HMR_RUNTIME__.updateRedirects(redirects)
})
}
13 changes: 0 additions & 13 deletions vuepress-starter/docs/.vuepress/.temp/internal/siteData.js
Original file line number Diff line number Diff line change
@@ -1,14 +1 @@
export const siteData = JSON.parse("{\"base\":\"/\",\"lang\":\"en-US\",\"title\":\" \",\"description\":\"This documentation will help you get started with Bastyon.\",\"head\":[],\"locales\":{}}")

if (import.meta.webpackHot) {
import.meta.webpackHot.accept()
if (__VUE_HMR_RUNTIME__.updateSiteData) {
__VUE_HMR_RUNTIME__.updateSiteData(siteData)
}
}

if (import.meta.hot) {
import.meta.hot.accept(({ siteData }) => {
__VUE_HMR_RUNTIME__.updateSiteData(siteData)
})
}
13 changes: 0 additions & 13 deletions vuepress-starter/docs/.vuepress/.temp/internal/themeData.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 0 additions & 13 deletions vuepress-starter/docs/.vuepress/.temp/pages/404.html.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
import comp from "/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/404.html.vue"
const data = JSON.parse("{\"path\":\"/404.html\",\"title\":\"\",\"lang\":\"en-US\",\"frontmatter\":{\"layout\":\"NotFound\"},\"headers\":[],\"git\":{},\"filePathRelative\":null}")
export { comp, data }

if (import.meta.webpackHot) {
import.meta.webpackHot.accept()
if (__VUE_HMR_RUNTIME__.updatePageData) {
__VUE_HMR_RUNTIME__.updatePageData(data)
}
}

if (import.meta.hot) {
import.meta.hot.accept(({ data }) => {
__VUE_HMR_RUNTIME__.updatePageData(data)
})
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,4 +1,82 @@
<template><div><h1 id="developer-documentation" tabindex="-1"><a class="header-anchor" href="#developer-documentation"><span>Developer Documentation</span></a></h1>
<p>Welcome to Bastyon developer documentation. Here you will find a lot of useful information, including how to get started, platform architectural overview, as well as the API reference.</p>
<h2 id="platform-overview" tabindex="-1"><a class="header-anchor" href="#platform-overview"><span>Platform overview</span></a></h2>
<p>Bastyon is an innovative, open-source social network and video sharing platform designed to prioritize freedom of speech and user privacy. Unlike mainstream social networks, Bastyon operates without centralized corporate control, instead relying on a distributed network of nodes worldwide. For more information, you can check out <RouteLink to="/get-started.html">get started</RouteLink> section of the documentation.</p>
<blockquote>
<p><strong>Vision:</strong>
Bastyon aims to create a resilient, decentralized ecosystem that empowers individuals with unrestricted access to communication, information, and personal data management. Our vision is to build a platform that stands strong against censorship and ensures user sovereignty in the digital realm.</p>
</blockquote>
<p>The platform operates on a distributed network of nodes running the Bastyon blockchain, which is based on a randomized Proof-of-Stake algorithm. This decentralized architecture ensures that no single entity can control or censor the platform.
Cryptocurrency Integration.
Bastyon utilizes its native cryptocurrency, <a href="https://www.coingecko.com/en/coins/pocketcoin+" target="_blank" rel="noopener noreferrer">PKOIN</a>, for incentivizing content creators and node operators.</p>
<p>todo: generate an overview of the platform, based on the github repo links
todo: generate the</p>
<h3 id="core-components" tabindex="-1"><a class="header-anchor" href="#core-components"><span>Core Components</span></a></h3>
<p>The Bastyon Platform is roughly broken down into Roadmap (new ideas and the roadmap for the ideas that made it out of the ideation phase), documentation, front-end component (Mobile Apps, Desktop and Web Browser App), the back-end component (Node Software, Blockchain Explorer, Bastyion Platform API and todo: what is control?)</p>
<p>Below are the repositories for each respective platform components</p>
<p>[todo] provide detailed descriptions for each repo</p>
<h4 id="bastyon-project-overview" tabindex="-1"><a class="header-anchor" href="#bastyon-project-overview"><span>Bastyon Project Overview</span></a></h4>
<p><a href="https://github.com/pocketnetteam/get.started" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/get.started</a></p>
<p><a href="https://github.com/pocketnetteam/get.started/issues/1" target="_blank" rel="noopener noreferrer">work tracking this</a></p>
<h4 id="roadmap" tabindex="-1"><a class="header-anchor" href="#roadmap"><span>Roadmap</span></a></h4>
<p><a href="https://github.com/pocketnetteam/roadmap" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/roadmap</a></p>
<p><a href="https://github.com/pocketnetteam/roadmap/issues/1" target="_blank" rel="noopener noreferrer">work tracking this</a></p>
<h4 id="documentation" tabindex="-1"><a class="header-anchor" href="#documentation"><span>Documentation</span></a></h4>
<p><a href="https://github.com/pocketnetteam/documentation" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/documentation</a></p>
<h4 id="front-end" tabindex="-1"><a class="header-anchor" href="#front-end"><span>Front-end</span></a></h4>
<h5 id="bastyon-application-ui" tabindex="-1"><a class="header-anchor" href="#bastyon-application-ui"><span>Bastyon Application UI</span></a></h5>
<p><a href="https://github.com/pocketnetteam/pocketnet.gui" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/pocketnet.gui</a></p>
<h5 id="bastyon-video-implementation" tabindex="-1"><a class="header-anchor" href="#bastyon-video-implementation"><span>Bastyon Video Implementation</span></a></h5>
<p><a href="https://github.com/pocketnetteam/bastyon-video" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/bastyon-video</a></p>
<h5 id="bastyon-messenger-ui" tabindex="-1"><a class="header-anchor" href="#bastyon-messenger-ui"><span>Bastyon Messenger UI</span></a></h5>
<p><a href="https://github.com/pocketnetteam/bastyon-video" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/bastyon-chat</a></p>
<h5 id="bastyon-calls-ui" tabindex="-1"><a class="header-anchor" href="#bastyon-calls-ui"><span>Bastyon Calls UI</span></a></h5>
<p><a href="https://github.com/pocketnetteam/bastyon-video" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/bastyon-calls</a></p>
<h4 id="back-end" tabindex="-1"><a class="header-anchor" href="#back-end"><span>Back-end</span></a></h4>
<p><a href="https://github.com/pocketnetteam/pocketnet.core" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/pocketnet.core</a></p>
<p><a href="https://github.com/pocketnetteam/pocketnet.explorer" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/pocketnet.explorer</a></p>
<p><a href="https://github.com/pocketnetteam/pocketnet.api" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/pocketnet.api</a></p>
<p><a href="https://github.com/pocketnetteam/pocketnet.control" target="_blank" rel="noopener noreferrer">https://github.com/pocketnetteam/pocketnet.control</a></p>
<h5 id="blockchain-and-node-network" tabindex="-1"><a class="header-anchor" href="#blockchain-and-node-network"><span>Blockchain and Node Network</span></a></h5>
<h3 id="quick-start-guide" tabindex="-1"><a class="header-anchor" href="#quick-start-guide"><span>Quick start guide</span></a></h3>
<h4 id="i-want-to-build-the-node-locally" tabindex="-1"><a class="header-anchor" href="#i-want-to-build-the-node-locally"><span>I want to build the node, locally</span></a></h4>
<p>[todo]: these should be instructions in each respective repo</p>
<h4 id="i-want-to-build-desktop-application-ui-locally" tabindex="-1"><a class="header-anchor" href="#i-want-to-build-desktop-application-ui-locally"><span>I want to build Desktop Application UI locally</span></a></h4>
<p>[todo]: these should be instructions in each respective repo</p>
<h4 id="i-want-to-build-messenger-locally" tabindex="-1"><a class="header-anchor" href="#i-want-to-build-messenger-locally"><span>I want to build Messenger, locally</span></a></h4>
<p>[todo]: these should be instructions in each respective repo
[todo]: anything else?</p>
<h2 id="community-and-support" tabindex="-1"><a class="header-anchor" href="#community-and-support"><span>Community and Support</span></a></h2>
<h3 id="community-guidelines" tabindex="-1"><a class="header-anchor" href="#community-guidelines"><span>Community guidelines</span></a></h3>
<h3 id="how-to-leave-feedback-on-bastyon" tabindex="-1"><a class="header-anchor" href="#how-to-leave-feedback-on-bastyon"><span>How to leave feedback on Bastyon</span></a></h3>
<h3 id="support-channels" tabindex="-1"><a class="header-anchor" href="#support-channels"><span>Support channels</span></a></h3>
<h3 id="feature-requests-and-bug-reporting" tabindex="-1"><a class="header-anchor" href="#feature-requests-and-bug-reporting"><span>Feature requests and bug reporting</span></a></h3>
<h3 id="faqs" tabindex="-1"><a class="header-anchor" href="#faqs"><span>FAQs</span></a></h3>
<h2 id="contribution-guide" tabindex="-1"><a class="header-anchor" href="#contribution-guide"><span>Contribution Guide</span></a></h2>
<pre><code>- How to contribute to Bastyon
- Code of conduct
- Development workflow
</code></pre>
<h2 id="user-guide" tabindex="-1"><a class="header-anchor" href="#user-guide"><span>User Guide</span></a></h2>
<pre><code>- Account setup and management
- Using the social platform features
- Messenger functionality
- Authorship on Bastyon
- Tutorials and How Tos
- Troubleshooting
</code></pre>
<h2 id="architecture-and-design" tabindex="-1"><a class="header-anchor" href="#architecture-and-design"><span>Architecture and Design</span></a></h2>
<pre><code>- System architecture
- Decentralization and blockchain integration
- Security features
</code></pre>
<h2 id="developer-documentation-1" tabindex="-1"><a class="header-anchor" href="#developer-documentation-1"><span>Developer Documentation</span></a></h2>
<pre><code>- API reference
- SDK documentation
- MiniApps development guide
- Best practices and examples
- Tutorials
</code></pre>
</div></template>


Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import comp from "/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/user-docs/advertisement-cpm-calculation.html.vue"
const data = JSON.parse("{\"path\":\"/en/user-docs/advertisement-cpm-calculation.html\",\"title\":\"CPM Derivation\",\"lang\":\"en-US\",\"frontmatter\":{},\"headers\":[{\"level\":3,\"title\":\"Bastyon.com Usage\",\"slug\":\"bastyon-com-usage\",\"link\":\"#bastyon-com-usage\",\"children\":[]},{\"level\":3,\"title\":\"Desktop App Usage\",\"slug\":\"desktop-app-usage\",\"link\":\"#desktop-app-usage\",\"children\":[]},{\"level\":3,\"title\":\"Android Usage\",\"slug\":\"android-usage\",\"link\":\"#android-usage\",\"children\":[]},{\"level\":3,\"title\":\"iOS Usage\",\"slug\":\"ios-usage\",\"link\":\"#ios-usage\",\"children\":[]},{\"level\":3,\"title\":\"CPM Calculation\",\"slug\":\"cpm-calculation\",\"link\":\"#cpm-calculation\",\"children\":[]}],\"git\":{\"updatedTime\":1728440694000,\"contributors\":[{\"name\":\"gked\",\"email\":\"[email protected]\",\"commits\":1}]},\"filePathRelative\":\"en/user-docs/advertisement-cpm-calculation.md\"}")
const data = JSON.parse("{\"path\":\"/en/user-docs/advertisement-cpm-calculation.html\",\"title\":\"CPM Derivation\",\"lang\":\"en-US\",\"frontmatter\":{},\"headers\":[{\"level\":3,\"title\":\"Bastyon.com Usage\",\"slug\":\"bastyon-com-usage\",\"link\":\"#bastyon-com-usage\",\"children\":[]},{\"level\":3,\"title\":\"Desktop App Usage\",\"slug\":\"desktop-app-usage\",\"link\":\"#desktop-app-usage\",\"children\":[]},{\"level\":3,\"title\":\"Android Usage\",\"slug\":\"android-usage\",\"link\":\"#android-usage\",\"children\":[]},{\"level\":3,\"title\":\"iOS Usage\",\"slug\":\"ios-usage\",\"link\":\"#ios-usage\",\"children\":[]},{\"level\":3,\"title\":\"CPM Calculation\",\"slug\":\"cpm-calculation\",\"link\":\"#cpm-calculation\",\"children\":[]}],\"git\":{\"updatedTime\":1728448132000,\"contributors\":[{\"name\":\"gked\",\"email\":\"[email protected]\",\"commits\":2}]},\"filePathRelative\":\"en/user-docs/advertisement-cpm-calculation.md\"}")
export { comp, data }

if (import.meta.webpackHot) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import comp from "/home/user/projects/bastyon/documentation/vuepress-starter/docs/.vuepress/.temp/pages/en/user-docs/buying-pkoin.html.vue"
const data = JSON.parse("{\"path\":\"/en/user-docs/buying-pkoin.html\",\"title\":\"Buying PKOIN\",\"lang\":\"en-US\",\"frontmatter\":{},\"headers\":[{\"level\":2,\"title\":\"Buying PKOIN on Exchanges and Exchange Services\",\"slug\":\"buying-pkoin-on-exchanges-and-exchange-services\",\"link\":\"#buying-pkoin-on-exchanges-and-exchange-services\",\"children\":[]},{\"level\":2,\"title\":\"Buying PKOIN peer-to-peer on Bastyon\",\"slug\":\"buying-pkoin-peer-to-peer-on-bastyon\",\"link\":\"#buying-pkoin-peer-to-peer-on-bastyon\",\"children\":[]}],\"git\":{\"updatedTime\":null,\"contributors\":[]},\"filePathRelative\":\"en/user-docs/buying-pkoin.md\"}")
const data = JSON.parse("{\"path\":\"/en/user-docs/buying-pkoin.html\",\"title\":\"Buying PKOIN\",\"lang\":\"en-US\",\"frontmatter\":{},\"headers\":[{\"level\":2,\"title\":\"Buying PKOIN on Exchanges and Exchange Services\",\"slug\":\"buying-pkoin-on-exchanges-and-exchange-services\",\"link\":\"#buying-pkoin-on-exchanges-and-exchange-services\",\"children\":[]},{\"level\":2,\"title\":\"Buying PKOIN peer-to-peer on Bastyon\",\"slug\":\"buying-pkoin-peer-to-peer-on-bastyon\",\"link\":\"#buying-pkoin-peer-to-peer-on-bastyon\",\"children\":[]}],\"git\":{\"updatedTime\":1728609014000,\"contributors\":[{\"name\":\"gked\",\"email\":\"[email protected]\",\"commits\":1}]},\"filePathRelative\":\"en/user-docs/buying-pkoin.md\"}")
export { comp, data }

if (import.meta.webpackHot) {
Expand Down
Loading

0 comments on commit a347211

Please sign in to comment.