Merge pull request #964 from DockYard-Academy/early_content_review

Fix README update script

README.md

@@ -36,71 +36,72 @@ Our program is designed to produce highly qualified Elixir developers. Upon comp
 See [start.livemd](https://github.com/DockYard-Academy/curriculum/blob/main/start.livemd) for a full breakdown of our lessons and exercises.
 
 <!-- course-outline-start -->
-## Core Syntax
+## Elixir Fundamentals
+* Prerequisites
 * Course Tools
 * Basics
 * Data Structures And Intro To Pattern Matching
 * Control Flow And Abstraction
 * Modules And Structs
 * Enumeration
-* Comprehensions And Non-Enumerable Data Types
 * Built-in Modules
+* Comprehensions And Non-Enumerable Data Types
 * Reduce
 * Dates And Time
 * String Manipulation
+* Recursion
 ## Mix Projects
 * Elixir Build Tooling
 * Testing With ExUnit
-* ExUnit With Mix Projects
 * Documentation And Static Analysis
 * Executables
-## OTP And Advanced Syntax
+## Advanced Syntax
 * Advanced Pattern Matching
 * Guarding
 * Protocols
-* Recursion
 * Persistence Using The File System
+## OTP
 * Processes
 * GenServers
-* Asynchronous Messages
+* Testing GenServers
 * Supervisor Basics And Fault Tolerance
-* Mix Projects And Processes
 * Concurrency With Tasks
-## Capstone Project Preparation
-* Capstone Project
-## Web Servers And Phoenix
+## Phoenix
 * HTML And CSS
-* APIs And Parsing JSON
+* APIs
+* Relational Databases
 * Phoenix
-* Tailwind
-* Ecto Changesets
 * Group Project Blog
 * Phoenix And Ecto
 * Testing Phoenix
-* Schemas And Migrations
+* Phoenix Forms And Components
 * Phoenix And Ecto One-to-Many Associations
-* Seeding
-* Phoenix Forms
 * Phoenix Authentication
 * Phoenix And Ecto Many-to-Many Relationships
 * Phoenix And Ecto One-to-One Relationships
+* Tailwind
 * Deployment
+* Custom Feature
 * Group Project Presentation
+## Capstone Project Preparation
+* Capstone Project
 ## LiveView
 * LiveView
 * LiveView And Ecto
+* LiveView Authentication
 * LiveView Image Uploads
 * PubSub
 * LiveView JS Interoperability And Pagination
-* Emailing, Swoosh, And Oban
+* Scheduling And Emailing With Swoosh And Oban
 ## Bonus Topics
 * Performance Optimization
 * Benchmarking And Performance
-* Streams
+* Ecto Changesets
 * State Management With Agents And ETS
 * Metaprogramming
-* Double-Ended Queues
+* Queues
 * Worker Pools
 * Rubix Cube Project
 
-<!-- course-outline-start -->
+<!-- course-outline-end -->
+

start.livemd

@@ -6,20 +6,19 @@ Use the following index to find reading material and exercises for this course.
 
 For new students, we recommend that you [start here](reading/start_here.livemd).
 
-## Prerequisites
+## Elixir Fundamentals
+
+### Prerequisites
 
 * Install [Elixir](https://elixir-lang.org/install.html)
 * Install [Livebook](https://github.com/livebook-dev/livebook)
 * Install [Postgres](https://www.postgresql.org/download/) (optional to get started)
 * Install [Phoenix](https://hexdocs.pm/phoenix/installation.html) (optional to get started)
 * Setup [WSL with Visual Studio Code](https://code.visualstudio.com/docs/remote/wsl) (Windows Users Only)
 * Optionally Install [asdf](https://asdf-vm.com/guide/getting-started.html) to manage Elixir and Erlang versions.
+* Basic understanding of [Computer Hardware](reading/computer_hardware.livemd)
 
-While we strongly recommend the [Visual Studio Code](https://code.visualstudio.com/) editor for its LiveShare capability, you may use any code editor you prefer.
-
-This course is intended to be approachable to students with no computer science background. However, you may find it useful to go through our [Computer Hardware](reading/computer_hardware.livemd) reading material to understand the basics of computers and how they work.
-
-## Elixir Fundamentals
+<!-- livebook:{"break_markdown":true} -->
 
 ### Course Tools
 

utils/README.md

@@ -6,11 +6,11 @@ Utilities For DockYard Academy.
 
 ```sh
 $ cd utils
-$ mix bc
-mix bc.add_git_section       # Add Git section to selected pages.
-mix bc.add_navigation        # Add Previous/Next navigation link to reading pages.
-mix bc.autolink              # Autolink Elixir functions to HexDocs.
-mix bc.format_headings       # Format headings of Livebook notebooks.
-mix bc.format_notebooks      # Format Livebook notebooks.
-mix bc.update_readme_outline # Update outline for README.md.
+$ mix all_tasks
+```
+
+## Tests
+
+```sh
+mix test
 ```

utils/lib/mix/tasks/update_readme_outline.ex

@@ -21,7 +21,7 @@ defmodule Mix.Tasks.UpdateReadmeOutline do
         """
         <!-- course-outline-start -->
         #{outline_snippet(outline)}
-        <!-- course-outline-start -->
+        <!-- course-outline-end -->
         """
       )