Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SHAcollision committed Jul 25, 2024
1 parent 0d65ab0 commit 3abb34f
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# :brain: Pubky Knowledge Base

Welcome to the Pubky Knowledge base - we are excited to have you here.

### 🔗 [Access the Pubky Knowledge Base Here!](https://vigilant-adventure-y6k6ere.pages.github.io/)

> **The current Knowledge base is a mix of reality, dreams, visions, actuality and plans.**
:brain: Welcome to he Pubky Knowledge base - we are excited to have you here.
The Knowledge Base is a resource that encompasses our broad vision for Pubky, along with high-level explanations of the architecture for both the Pubky Protocol and the Pubky App, as well as key concepts. Use this as your go-to guide to help you navigate unfamiliar topics and find answers to the most common questions.

## 📝 Contributing Knowledge

We kindly ask you to help us improve this documentation for a clearer, more accurante and concise kowledge base. Simply open a PR!

## 🏗️ Build static Quartz site

The Knowledge Base is a resource that encompasses our broad vision for Pubky, along with high-level explanations of the architecture for both the Pubky Protocol and the Pubky App, as well as key concepts. Use this as your go-to guide to help you navigate unfamiliar topics and find answers to the most common questions. The full Knowledge Base can be accessed [here](https://vigilant-adventure-y6k6ere.pages.github.io/)
In order to build the static website from this obsidian vault, ensure that [NodeJS](https://nodejs.org/en/download/prebuilt-installer) is installed on your system.

![Pubky architecture](images/pubky_arch.png)
1. Enter in the terminal to the project root and access to the `/quartz` directory (`cd quartz`)
2. Install dependencies with `npm install`
3. Finally build the site with `npm run docs` and check it out at [localhost:8080](http://localhost:8080/)

0 comments on commit 3abb34f

Please sign in to comment.