This documentation aims to facilitate efficient and effective participation in the PlanB Content Repository, ensuring the availability of high-quality, accessible educational resources on Bitcoin. It covers the following aspects:
The PlanB Content Repo is designed to serve as a centralized 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.
The PlanB content is available in the following languages:
- Arabic: Review Dashboard
- Danish: Review Dashboard
- English: Website, Review Dashboard
- Finnish: Review Dashboard
- French: Website, Review Dashboard
- German: Website, Review Dashboard
- Italian: Website, Review Dashboard
- Japanese: Review Dashboard
- Polish: Review Dashboard
- Portuguese: Website, Review Dashboard
- Spanish: Website, Review Dashboard
- Thaï: Review Dashboard
If your language is not listed here, please suggest it by opening an issue. 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).
The repository is organized according to the following hierarchy:
- Courses: Course content are stored here and must respect some format specification
- Tutorials: Tutorials are stored in categories and must respect some format specification
- Resources: Four type of resources (book, builder, conference, and podcast) are stored here and each of them has their own set of format specification
- Exam: Exams and quizzes are stored here, and each of them has their own set of format specification
- Standards: standards are stored here and must respect some format specification
For general aspect and specification that are used throughout the entire repo, please refere to the guidelines provided here
Here's a visual representation of it:
sovereign-university-data/
│
├── courses/
│ ├── course101/
│ └── ...
│
├── tutorials/
│ ├── exchange/
│ │ ├── tutorial101/
│ │ └── ...
│ ├── merchant/
│ ├── node/
│ ├── wallet/
│ └── other/
│
├── resources/
│ ├── books/
│ │ ├── book-eg/
│ │ └── ...
│ ├── builders/
│ │ ├── builder-eg/
│ │ └── ...
│ ├── conferences/
│ │ ├── conference-eg/
│ │ └── ...
│ └── podcasts/
│ ├── podcast-eg/
│ └── ...
│
├── exams/
│ └── ...
│
└── standards/
└── ..
Detailed specifications for the format of each content type are provided in separate documents:
- For courses, refer to the Course Documentation.
- For tutorials, refer to the Tutorial Documentation.
- For books, refer to the Book Documentation.
- For builders, refer to the Builder Documentation.
- For conferences, refer to the Conference Documentation.
- For podcasts, refer to the Podcast Documentation.
- For exams, refer to the Exam Documentation.
- For standards, refer to the Standards Documentation.
Contributions to the PlanB Content Repo are encouraged and welcomed. Here's how you can contribute effectively:
- Reviewing Content: Directly review content within the GitHub repository. This can involve tasks such as correcting typos, clarifying content, or reviewing automated translations. Refer to this tutorial for detailed instructions on the reviewing process.
- Adding New Content: If you wish to add new content to the repository, refer to our tutorial for step-by-step guidance. Alternatively, you can find instructions on our website or within the GitHub repository.
- Contributing to the PlanB Website: For contributions specifically related to the PlanB website, please refer to the corresponding repo
If you have any questions or remarks, feel free to join our Telegram group and be part of the PlanB Content Builders 🤙