Misc feedback

alex-snezhko · alex-snezhko · commit d81d4409ca2c · 2024-12-12T22:12:06.000-08:00
diff --git a/src/components/BlogEntry.astro b/src/components/BlogEntry.astro
@@ -61,7 +61,7 @@ const { entry } = Astro.props;
     <Image
       src={entry.data.cover}
       alt={entry.data.coverAttribution ?? ""}
-      class="max-h-[26rem] w-full object-cover"
+      class="rounded max-h-[26rem] w-full object-cover"
     />
     <figcaption class="pt-2 text-sm text-gray-50">Photo: {entry.data.coverAttribution}</figcaption>
   </figure>
diff --git a/src/components/BlogHero.astro b/src/components/BlogHero.astro
@@ -35,7 +35,7 @@ const { entry } = Astro.props;
       </a>
     </div>
     <div class="hidden md:block text-color-accent">
-      Find us also on
+      Also find us on
       <a href="https://twitter.com/grain_lang" class="underline">Twitter</a>
       and
       <a href="https://discord.com/invite/grain-lang" class="underline">Discord</a>
@@ -53,11 +53,13 @@ const { entry } = Astro.props;
       </a>
     </div>
     <div class="w-0 lg:w-7/12 pl-6">
-      <Image
-        src={entry.data.cover}
-        alt={entry.data.coverAttribution ?? `${entry.data.title} cover image`}
-        class="w-full h-full object-cover rounded"
-      />
+      <a href={`/blog/${entry.id}`}>
+        <Image
+          src={entry.data.cover}
+          alt={entry.data.coverAttribution ?? `${entry.data.title} cover image`}
+          class="w-full h-full object-cover rounded"
+        />
+      </a>
     </div>
   </div>
 </div>
diff --git a/src/components/BlogThumbnail.astro b/src/components/BlogThumbnail.astro
@@ -10,7 +10,7 @@ interface Props {
 const { entry } = Astro.props;
 ---
 
-<div class="flex flex-col drop-shadow-sm border rounded-lg border-gray-10 dark:border-color-background-bright dark:bg-color-dim-3 overflow-hidden">
+<div class="flex flex-col drop-shadow-sm border rounded-lg border-gray-10 dark:border-color-background-bright dark:bg-color-dim-3 overflow-hidden hover:shadow-lg transition duration-150">
   <a href={`/blog/${entry.id}`} class="grow flex flex-col">
     <Image
       src={entry.data.cover}
diff --git a/src/components/Contributors.astro b/src/components/Contributors.astro
@@ -27,15 +27,15 @@ const special = [
     .map(contributor => (
       <div class="inline-block relative">
         <a href={contributor.html_url} class="p-0.5 inline-block">
-          <img class="w-14 h-14 rounded-full p-0.5 shadow-md border border-color-dim-2 dark:shadow-purple-80" src={contributor.avatar_url} alt={`Image of ${contributor.login}`} />
+          <img class={`w-14 h-14 rounded-full p-0.5 border ${special.includes(contributor.login) ? "shadow-[0_0px_8px_1px_rgb(0_0_0/0.1)] border-amber-600 shadow-amber-500" : "shadow-md border-color-dim-2"} dark:shadow-purple-80`} src={contributor.avatar_url} alt={`Image of ${contributor.login}`} />
         </a>
         {special.includes(contributor.login) && (
-          <a href={contributor.html_url} class="absolute text-3xl bottom-0 right-0 text-yellow-500 [text-shadow:0_0_2px_#000]">★</a>
+          <a href={contributor.html_url} class="absolute text-2xl bottom-0 right-0 text-yellow-500 [text-shadow:0_0_2px_#000]">🌾</a>
         )}
       </div>
     ))}
 
   <p class="mt-6">
-    <span class="text-2xl text-yellow-500">★</span> = Noteworthy contributors who have made signifant contributions to the project.
+    <span class="text-2xl text-yellow-500 align-middle">🌾</span><span class="align-middle"> = Noteworthy contributors to the project.</span>
   </p>
 </div>
diff --git a/src/components/OpenSourceBlurb.astro b/src/components/OpenSourceBlurb.astro
@@ -20,7 +20,7 @@ import Card from "./Card.astro";
   <div class="mx-auto">
     <div class="grid grid-cols-1 lg:grid-cols-2 gap-5 lg:gap-14">
       <Card title="We continuously strive to" class="bg-color-background-bright">
-        <ul class="pl-6 [&>li]:my-1 [&>li]:pl-1 text-color-accent list-outside list-image-[url(/src/images/check-icon.svg)]">
+        <ul class="pl-6 [&>li]:my-1 [&>li]:pl-1 text-color-accent dark:text-[rgb(255,132,92)] list-outside list-image-[url(/src/images/check-icon.svg)]">
           <li>Improve the language</li>
           <li>Address more use cases and provide exceptional documentation</li>
           <li>Prioritize developer experience</li>
@@ -34,9 +34,10 @@ import Card from "./Card.astro";
         </p>
       </Card>
       <Card title="Sponsors and Contributors" class="bg-color-background-bright relative">
-        <div class="z-10 absolute -top-10 right-[10rem] bg-color-blurb-4 w-36 h-[32rem] rounded-full rotate-[10deg] blur-3xl" data-desc="color-ellipsis" />
+        <div class="z-10 absolute -top-10 right-[10rem] bg-color-blurb-4 w-36 h-[32rem] rounded-full rotate-[10deg] blur-3xl" />
         <div class="z-10 absolute -top-10 right-[3rem] bg-color-blurb-2 w-36 h-[32rem] rounded-full rotate-[10deg] blur-3xl" />
-        <div class="z-10 absolute top-0 -right-[3rem] bg-color-blurb-3 w-36 h-[32rem] rounded-full rotate-[10deg] blur-3xl" data-desc="color-ellipsis" />
+        <div class="z-10 absolute top-0 -right-[3rem] bg-color-blurb-3 w-36 h-[32rem] rounded-full rotate-[10deg] blur-3xl" />
+        <div class="z-10 absolute w-full h-full bg-[rgb(255,255,255,0.4)] dark:bg-[rgb(29,24,46,0.4)] blur-3xl"></div>
         <p class="z-20">
           We rely on volunteer contributors and sponsors to sustain the project.
           Development of the Grain programming language is financially
diff --git a/src/components/TableOfContentsHeading.astro b/src/components/TableOfContentsHeading.astro
@@ -9,7 +9,7 @@ const { heading } = Astro.props;
 ---
 
 <li class="my-1.5">
-  <a href={"#" + heading.id}>
+  <a href={"#" + heading.slug}>
     {heading.text}
   </a>
   {heading.subheadings.length > 0 && (
diff --git a/src/content/docs/guide/05-mutation.md b/src/content/docs/guide/05-mutation.md
@@ -72,7 +72,7 @@ It is also possible to create a binding with the same name as an existing bindin
 module Main
 
 let val = 1
-let val = 2 // `val` now refers a new value
+let val = 2 // `val` now refers to a new value
 ```
 
 It is important to note that shadowing does not modify what the shadowed binding refers to, but rather makes a new association for a binding name within the scope:
diff --git a/src/content/docs/guide/06-loops.md b/src/content/docs/guide/06-loops.md
@@ -54,7 +54,7 @@ while (true) {
 ```grain
 module Main
 
-import Array from "array"
+from "array" include Array
 
 let strings = [> "foo", "bar", "baz"]
 
diff --git a/src/content/docs/guide/07-lists_and_arrays.md b/src/content/docs/guide/07-lists_and_arrays.md
@@ -1,6 +1,6 @@
 ---
-title: Collections and Libraries
-slug: guide/collections_and_libraries
+title: Lists and arrays
+slug: guide/lists_and_arrays
 ---
 
 ## Lists
@@ -116,7 +116,9 @@ In some cases, this could allow us to write programs that are more efficient tha
 However, the size of an array is fixed. To add additonal items to an array, we must append them together, which would create a brand new, third array:
 
 ```grain
-import Array from "array"
+module Main
+
+from "array" include Array
 
 let one = [> 1]
 let twoThree = [> 2, 3]
diff --git a/src/content/docs/intro/02-getting_grain.md b/src/content/docs/intro/02-getting_grain.md
@@ -9,7 +9,7 @@ We have a couple different ways to get Grain. Most developers will prefer the Pa
 
 The Grain toolchain (including our CLI, compiler, runtime, and standard library) is shipped as a single binary. Binaries are available for [MacOS x64](#MacOS-x64---Homebrew), [Linux x64](#Linux-x64---Download), and [Windows x64](#Windows-x64---Download).
 
-**Note:** These binaries are a bit slow when first building a project (around 70 seconds). The packaged compiler is running in JavaScript, _and_ it builds and writes the runtime & standard library into your project. If you need raw speed, you can build the native compiler from source! See [Building Grain from Source](#Building-Grain-from-Source) below.
+**Note:** These binaries are a bit slow when first building a project (around 10 seconds). The packaged compiler is running in JavaScript, _and_ it builds and writes the runtime & standard library into your project. If you need raw speed, you can build the native compiler from source! See [Building Grain from Source](#Building-Grain-from-Source) below.
 
 ### MacOS x64 - Homebrew
 
@@ -23,30 +23,30 @@ _The `--no-quarantine` flag will avoid having to approve the binary in the Secur
 
 ### MacOS x64 - Download
 
-If you'd prefer not to use homebrew, you can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-mac-x64) directly from GitHub or using `curl`.
+If you'd prefer not to use homebrew, you can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-mac-x64) directly from GitHub or using `curl`.
 
 ```sh
 sudo curl -L --output /usr/local/bin/grain \
-https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-mac-x64 \
+https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-mac-x64 \
 && sudo chmod +x /usr/local/bin/grain
 ```
 
 ### Linux x64 - Download
 
-You can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-linux-x64) directly from GitHub or using `curl`.
+You can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-linux-x64) directly from GitHub or using `curl`.
 
 ```sh
 sudo curl -L --output /usr/local/bin/grain \
-https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-linux-x64 \
+https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-linux-x64 \
 && sudo chmod +x /usr/local/bin/grain
 ```
 
 ### Windows x64 - Download
 
-You can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-win-x64.exe) directly from GitHub or using `curl`.
+You can [download it](https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-win-x64.exe) directly from GitHub or using `curl`.
 
 ```batch
-curl -LO https://github.com/grain-lang/grain/releases/download/grain-v0.5.13/grain-win-x64.exe
+curl -LO https://github.com/grain-lang/grain/releases/download/grain-v0.6.6/grain-win-x64.exe
 ```
 
 You'll either want to put it into your path or keep it inside your project and invoke with `.\grain-win-x64.exe`.
diff --git a/src/content/docs/reference/builtin_types.md b/src/content/docs/reference/builtin_types.md
@@ -13,31 +13,31 @@ enum Bool {
 }
 ```
 
-The type of Grain booleans, i.e. the type of `true` and `false`.
+The type of Grain booleans, i.e. `true` or `false`.
 
 ### **Char**
 
 ```grain
 type Char
 ```
 
-The type of Grain Unicode characters, i.e. `'g'`, `'🌾'`, `'💻'`.
+The type of Grain Unicode characters, e.g. `'g'`, `'🌾'`, `'💻'`.
 
 ### **String**
 
 ```grain
 type String
 ```
 
-The type of Grain strings, i.e. `"The quick brown fox jumps over the lazy dog."`.
+The type of Grain strings, e.g. `"The quick brown fox jumps over the lazy dog."`.
 
 ### **Bytes**
 
 ```grain
 type Bytes
 ```
 
-The type of Grain byte sequences.
+The type of Grain byte sequences, e.g. `b"The quick brown fox jumps over the lazy dog."`
 
 ### **Void**
 
@@ -47,15 +47,44 @@ enum Void {
 }
 ```
 
-The type of `void`, also known as "unit" or "nothing".
+The type of `void`, Grain's special type for indicating the absence of a meaningful value i.e. Grain's [unit type](https://en.wikipedia.org/wiki/Unit_type).
+
+### **Option**
+
+```grain
+enum Option<a> {
+  Some(a),
+  None
+}
+```
+
+The type of Grain options (e.g. `Some(1)` or `None`). The `a` is the type of the value. Options are analagous to nullable values in some other languages, but are much safer to work with due to the nullability being encoded explicitly in the type.
+
+### **Result**
+
+```grain
+enum Result<t, e> {
+  Ok(t),
+  Err(e)
+}
+```
+
+The type of Grain results (e.g. `Ok(1)` or `Err("Something went wrong")`). The `t` and `e` are the types of the value and error, respectively. This is useful for functions that might fail.
 
 ### **Array**
 
 ```grain
 type Array<a>
 ```
 
-The type of Grain arrays, i.e. `[> 1, 2, 3]`. Arrays are fixed-length and allow for efficient get/set operations at any index.
+The type of Grain arrays, e.g. `[> 1, 2, 3]`. Arrays are fixed-length and allow for efficient get/set operations at any index.
+
+### **List**
+
+```grain
+type List<a>
+```
+The type of Grain lists (linked lists), e.g. `[1, 2, 3]`. Lists are immutable and allow for values to be efficiently appended.
 
 ### **Box**
 
@@ -65,53 +94,119 @@ type Box<a>
 
 The type of Grain boxes. Boxes are wrappers that allow the internal data to be swapped during execution.
 
+### **Range**
+
+```grain
+record Range<a> {
+  rangeStart: a,
+  rangeEnd: a
+}
+```
+
+A range of values, with a start and end value.
+
+### **Rational**
+
+```grain
+type Rational
+```
+
+The type of Grain rationals, e.g. `2/3r`. Rationals are represented as a numerator and denominator.
+
 ### **Number**
 
 ```grain
 type Number
 ```
 
-The type of Grain numbers, i.e. `42`, `0x2a`, `23.19`, `2/3`. Grain numbers can be arbitrarily large integers, floats, or rationals.
+The type of Grain numbers, e.g. `42`, `0x2a`, `23.19`, `2/3`. Grain numbers can be arbitrarily large integers, floats, or rationals.
 
 ### **BigInt**
 
 ```grain
 type BigInt
 ```
 
-The type of arbitrarily large integers, i.e. `42t`, `9_223_372_036_854_775_808t`.
+The type of arbitrarily large integers, e.g. `42t`, `9_223_372_036_854_775_808t`.
+
+### **Int8**
+
+```grain
+type Int8
+```
+
+The type of 8-bit integers, e.g. `127s`, `-127s`, `0x01s`.
+
+### **Uint8**
+
+```grain
+type Uint8
+```
+
+The type of 8-bit unsigned integers, e.g. `255us`, `42us`, `0x01us`.
+
+### **Int16**
+
+```grain
+type Int16
+```
+
+The type of 16-bit integers, e.g. `32768S`, `-32768S`, `0x01S`.
 
+### **Uint16**
+
+```grain
+type Uint16
+```
+
+The type of 16-bit unsigned integers, e.g. `65535uS`, `42uS`, `0x01uS`.
 ### **Int32**
 
 ```grain
 type Int32
 ```
 
-The type of 32-bit integers, i.e. `42l`, `0x2al`.
+The type of 32-bit integers, e.g. `42l`, `0x2al`.
+
+### **Uint32**
+
+```grain
+type Uint32
+```
+
+The type of 32-bit unsigned integers, e.g. `42ul`, `0x2aul`.
 
 ### **Int64**
 
 ```grain
 type Int64
 ```
 
-The type of 64-bit integers, i.e. `42L`, `0x2aL`.
+The type of 64-bit integers, e.g. `42L`, `0x2aL`.
+
+### **Uint64**
+
+```grain
+type Uint64
+```
+
+The type of 64-bit unsigned integers, e.g. `42uL`, `0x2auL`.
 
 ### **Float32**
 
 ```grain
 type Float32
 ```
 
-The type of 32-bit floating-point numbers, i.e. `3.5f`.
+The type of 32-bit floating-point numbers, e.g. `3.5f`.
 
 ### **Float64**
 
 ```grain
 type Float64
 ```
 
-The type of 64-bit floating-point numbers, i.e. `3.5d`.
+The type of 64-bit floating-point numbers, e.g. `3.5d`.
 
 ### **Exception**
 
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,5 +1,5 @@
 export interface HeirarchicalHeading {
-  id: string;
+  slug: string;
   text: string;
   subheadings: HeirarchicalHeading[];
 }
