This documentation aims to facilitate efficient and effective participation in the Bitcoin Educational Content Repository, ensuring the availability of high-quality, accessible educational resources on Bitcoin. It covers the following aspects:
- Purpose
- Supported Languages
- Repository Structure
- Expected Format for Different Types of Content
- How to Contribute
The Bitcoin Educational Content Repo is designed to serve as a centralised hub for high-quality educational resources related to Bitcoin. Its key objectives include:
- Facilitating understanding and adoption of Bitcoin technology.
- Providing access to a wide range of educational materials, software, and hardware recommendations.
- Enabling contribution and collaboration from a diverse community of users and developers.
- Breaking down language barriers to ensure accessibility and inclusivity. For a list of supported languages, refer to the Supported Languages section below.
Thanks to our contributors, the Plan ₿ Network content is available in many languages and we are able to keep adding new languages.
To see which languages are already available, just browse our website and switch to your preferred language.
If you want to contribute to any existing content by proofreading it to improve translation quality or you want to add a missing language, please read our Readme file dedicated section, have a look to our Content Translation & Proofreading Dashboard and engage with us in the Telegram Content Builder Group
The repository is organised according to the following hierarchy:
- Courses: Course content are stored here and must respect some format specification
- Professors: Each professor has a profile with relevant data. You can find complete specifications about professors in the PBN Template Repo folder with examples and comments. Professors are identifiead through content by using the associated Plan₿-UID.
- Resources: Five type of resources (book, builder,conference, glossary and podcast) are stored here. You can find complete specifications about each of them in the corresponding subfolder in Template Repo folder with examples and comments.
- Scripts: Scripts are used to perform specific action or to automate some tasks. Usually PBN staff will use them or ask contributors to use them only if needed.
- Tutorials: Tutorials are stored in categories and must respect some format specification
Here's a quick visual representation of repository structure:
bitcoin-educational-content/
│
├── courses/
│ ├── course101/
│ └── ...
|
├── professors/
│ ├── professor/-eg
│ └── ...
│
├── resources/
│ ├── bet/
│ ├── books/
│ │ ├── book-eg/
│ │ └── ...
│ ├── builders/
│ │ ├── builder-eg/
│ │ └── ...
│ ├── conference/
│ │ ├── conference-eg/
│ │ └── ...
│ └── glossary/
│ │ ├── word-eg/
│ │ └── ...
│ └── podcasts/
│ ├── podcast-eg/
│ └── ...
│
├── scripts/
│ └── ...
|
├── tutorials/
│ ├── exchange/
│ │ ├── tutorial101/
│ │ └── ...
│ ├── merchant/
│ ├── mining/
│ ├── node/
│ ├── other/
│ └── privacy/
│ └── wallet/
As mentioned in Repository Structure paragraph, each type of content has its own format specifications. Detailed templates for each type are provided in the folder template Repo where you can find full examples of folder and files structure and extensive comments inside all files to understand how to properly format your content.
Contributions to the Bitcoin Educational Content Repo are encouraged and welcome.
As we believe in the value-4-value model, we are always looking for contributors that are willing to review content in exchange of some sats (and knowledge).
If you want to contribute please read our Readme file dedicated section, have a look to our Content Translation & Proofreading Dashboard and engage with us in the Telegram Content Builder Group and be part of the Plan ₿ Network Content Builders 🤙