From 908a00231d3f6658d76c61fde95ee8004b80062d Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:09:34 -0700 Subject: [PATCH 1/4] init commit Inclusion of chia academy header, sidebar, intro page, and overview (template) --- .../academy/academy-intro/academy-overview.md | 43 +++++++++++++++++++ docusaurus.config.js | 6 +++ sidebars.js | 18 ++++++++ 3 files changed, 67 insertions(+) create mode 100644 docs/academy/academy-intro/academy-overview.md diff --git a/docs/academy/academy-intro/academy-overview.md b/docs/academy/academy-intro/academy-overview.md new file mode 100644 index 0000000000..81b807b3f9 --- /dev/null +++ b/docs/academy/academy-intro/academy-overview.md @@ -0,0 +1,43 @@ +--- +title: Academy Overview +slug: /academy-overview +--- + +The lesson pages in Chia Academy are thoughtfully designed to enhance the learning experience for students. Each lesson is organized in a user-friendly and visually appealing manner. The structure typically includes: + +--- + +## Lesson title: +Each lesson starts with a clear and descriptive title that informs students about the topic they are about to explore. + +--- + +## Learning objectives: +A set of specific learning objectives is provided at the beginning of the lesson. These objectives outline what students will be able to understand or do by the end of the lesson, setting clear expectations + +--- + +## Content: +The core content in each lesson is conveyed through structured short format videos followed by summaries. This hybrid visual and text approach ensures accessibility and caters to diverse learning preferences. + +--- + +## Script: +Each of the short format videos will be proceeded by the script used for creating the video. This written format ensures ease of translation catering to diverse learners. + +--- + +## Common gotchas: +While lessons are thoughtfully designed to facilitate learning, there are some common pitfalls or challenges that a learner might face. These will be described after the script for each lesson. + +--- + +## Knowledge check +Each lesson contains a brief quiz designed to gauge learners' comprehension and retention of the video material. These assessments reinforce key concepts and help learners self-asses their understanding. + +--- + +## Additional resources: +Links to additional reading materials, videos, or external resources may be provided for learners who wish to delve deeper into the lessons subject. + +--- diff --git a/docusaurus.config.js b/docusaurus.config.js index 1253a92731..54c7fec7a6 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -59,6 +59,12 @@ const katex = require('rehype-katex'); position: 'left', label: 'Guides', }, + { + href: 'academy/introduction', + label: 'Chia Academy', + docId: '/academy-intro' + position: 'left', + }, { href: 'https://chialisp.com', label: 'Chialisp', diff --git a/sidebars.js b/sidebars.js index 75200f2cc6..6f55790729 100644 --- a/sidebars.js +++ b/sidebars.js @@ -396,4 +396,22 @@ module.exports = { ], }, ], + academy: [ + { + type: 'category', + label: 'Chia Academy Intro', + collapsible: false, + collapsed: false, + link: { + type: 'generated-index', + slug: '/academy/academy-intro', + title: 'Chia Academy Intro', + description: + 'Welcome to Chia Academy, the scholarly hub for delving deep into Chia blockchain technology. In an age characterized by rapid digital transformation, this institution offers a comprehensive exploration of the Chia blockchain, dissecting its technical intricacies, real-world applications, and the nuances of its secure data handling. The Chia blockchain, created by Bram Cohen, stands out from traditional cryptocurrencies with its unique Proof of Space and Time (PoST) model, which contrasts with the energy-intensive Proof of Work (PoW) used by Bitcoin. This innovation is notable for its eco-friendly approach to blockchain. As a Chia Academy student, you will dive into the core concepts and functionalities of the Chia blockchain, including:', + }, + items: [ + 'academy/academy-intro/overview', + ], + }, + ], }; From 60763d7e40f2c4f801edb9ff1e204a48b560e1dd Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:17:01 -0700 Subject: [PATCH 2/4] config fixes fixes for the academy updates in the config --- docusaurus.config.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 54c7fec7a6..f1100707d4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -60,10 +60,10 @@ const katex = require('rehype-katex'); label: 'Guides', }, { - href: 'academy/introduction', - label: 'Chia Academy', - docId: '/academy-intro' + type: 'doc', + docId: '/academy-intro', position: 'left', + label: 'Chia Academy', }, { href: 'https://chialisp.com', From a81557d03635d4bff6bd8e943ef0e004967dcba9 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:22:00 -0700 Subject: [PATCH 3/4] sidebar fix fix for academy sidebar --- sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index 6f55790729..e6a13c1af7 100644 --- a/sidebars.js +++ b/sidebars.js @@ -410,7 +410,7 @@ module.exports = { 'Welcome to Chia Academy, the scholarly hub for delving deep into Chia blockchain technology. In an age characterized by rapid digital transformation, this institution offers a comprehensive exploration of the Chia blockchain, dissecting its technical intricacies, real-world applications, and the nuances of its secure data handling. The Chia blockchain, created by Bram Cohen, stands out from traditional cryptocurrencies with its unique Proof of Space and Time (PoST) model, which contrasts with the energy-intensive Proof of Work (PoW) used by Bitcoin. This innovation is notable for its eco-friendly approach to blockchain. As a Chia Academy student, you will dive into the core concepts and functionalities of the Chia blockchain, including:', }, items: [ - 'academy/academy-intro/overview', + 'academy/academy-intro/academy-overview', ], }, ], From 77dd94196e6ae337a1318373cb91c33b04bd1ccc Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:33:30 -0700 Subject: [PATCH 4/4] sidebar fix fix for academy sidebar --- sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index e6a13c1af7..71dced0add 100644 --- a/sidebars.js +++ b/sidebars.js @@ -404,7 +404,7 @@ module.exports = { collapsed: false, link: { type: 'generated-index', - slug: '/academy/academy-intro', + slug: '/academy-intro', title: 'Chia Academy Intro', description: 'Welcome to Chia Academy, the scholarly hub for delving deep into Chia blockchain technology. In an age characterized by rapid digital transformation, this institution offers a comprehensive exploration of the Chia blockchain, dissecting its technical intricacies, real-world applications, and the nuances of its secure data handling. The Chia blockchain, created by Bram Cohen, stands out from traditional cryptocurrencies with its unique Proof of Space and Time (PoST) model, which contrasts with the energy-intensive Proof of Work (PoW) used by Bitcoin. This innovation is notable for its eco-friendly approach to blockchain. As a Chia Academy student, you will dive into the core concepts and functionalities of the Chia blockchain, including:',