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

The current Knowledge base is a mix of reality, dreams, visions, actuality and plans.

The Knowledge Base is a comprehensive resource that encompasses our vision for Pubky, along with detailed explanations of the architecture for both Pubky Core and Pubky App, as well as key concepts and practical guides.

We kindly ask you to help us improve this documentation for a clearer, more accurate, and concise knowledge base.

For typos, broken links, or small improvements:

1. Fork this repository
2. Make your changes
3. Submit a pull request

For new pages or significant changes:

1. Open an issue to discuss your plans first
2. Follow the [[Contributing]] guide
3. Test locally before submitting

See our full [[Contributing|Contributing Guide]] for detailed instructions.

The knowledge base is built using Quartz, a static site generator optimized for knowledge bases.

• Node.js 18+ installed

# 1. Navigate to quartz directory
cd quartz

# 2. Install dependencies
npm install

# 3. Build and serve locally
npm run docs

# 4. Open browser
# Visit http://localhost:8080

cd quartz
npm run build

Output will be in quartz/public/ directory.

• Official Website: pubky.org
• Main Repository: github.com/pubky/pubky-core
• Telegram: t.me/pubkycore
• Live App: pubky.app

This documentation is licensed under the MIT License. See LICENSE for details.

For GitHub Contributors: This README is specifically for the documentation repository. The actual knowledge base lives at pubky.org.