grain-lang/grain-lang.org

The Grain language website.

grain-lang.org's Issues

Document List.drop and List.dropWhile

Introduced in grain-lang/grain#318

Document pattern matching with guards

RSS for blog

Ref grain-lang/grain#662

Implement 404 page

Document Range stdlib

I added this, so I should probably add the docs.

Document new String methods

Show blog email list sign up form on mobile

Github Pages HTTPS

Github pages now supports HTTPS and uses a CDN, so no need for the current reverse proxy.

Update stdlib documentation for Option returns instead of failures

The stdlib now returns Option instead of failing for some methods. I'll get those updated.

Blog?

I'd like to write a blog introducing the let mut feature that was PRed today. I didn't get a chance to write it tonight, but I hope to put something together soon.

It would be great to be able to include the blog posts in the static site generator engine.

Header links for H2s are broken

It looks like the ::before hack is broken because of the border-top on the h2's.

Syntax highlighting for type annotations is broken

Automatically scroll navs to active item on page load

Idea came from this Twitter thread: https://twitter.com/hakimel/status/1262337065670316033?s=20

Improve instructions for Getting Grain on Windows

You can download it directly from GitHub.

For Linux and MacOS, there's an added "(...) or using curl."

Since 2018, curl is available on Windows by default (see: https://devblogs.microsoft.com/commandline/tar-and-curl-come-to-windows/). So the docs could be updated.

Alternatively, ...

..., if you want to support older systems, there's the Invoke-WebRequest PowerShell cmdlet that can be used to download a file (e.g. Invoke-WebRequest -Uri <URL> -OutFile <FILE> -UseBasicParsing or iwr <URL> -o <FILE> -useb for short).

---

You’ll either want to put it into your path or keep it inside your project and invoke with ./grain-win-x64.exe.

./ only works in PowerShell. In cmd, you'd want .\:

C:\> ./grain-win-x64.exe -v
'.' is not recognized as an internal or external command,
operable program or batch file.

C:\> .\grain-win-x64.exe -v
Grain cli 0.3.1
Grain compiler 0.3.1

.\ works in PowerShell, too, so I'd suggest using .\grain-win-x64.exe instead.

As a side note, ...

..., if you want to save 4 characters, you can omit .exe: Since .exe is defined as a path extension in the PATHEXT environment variable, .\grain-win-x64 is equivalent to .\grain-win-x64.exe in both cmd and PowerShell.

Also, if the file is in the same directory, .\ is not necessary in cmd, so grain-win-x64 -v is equivalent to .\grain-win-x64 -v. (This does not apply to PowerShell, however.)

[Windows] Can't build the docs on Windows

Problem Description

Currently, it seems that the docs can be built only on Linux & MacOS but not on Windows.

Steps to reproduce

1. Clone the repository & initialize the submodules.
2. Run npm install
3. Run npm run start-docs

Expected behavior

The docs should build & the stdout should show that the static files are being served on port 3000.

Actual behavior

The docs are built but the express server doesn't serve them on 3000.

Additional Information

OS Platform & Version: Windows 10, Version 10.0.18363, Build 18363

Document Option stdlib

Pr here: grain-lang/grain#158

Update docs for List with new functions

Functions added are from grain-lang/grain#144

Document exceptions

Document strings and string escapes

This is the page that needs updating: https://grain-lang.org/docs/constructs/strings

Document Map stdlib

https://github.com/grain-lang/grain/blob/master/stdlib/map.gr

Document Char stdlib

Need it

Document Stack lib

See grain-lang/grain#491

Document Set stdlib

Once grain-lang/grain#466 lands

Unhide language constructs docs

These docs should be re-enabled on the site when they are more mature.

Show nav links on mobile

Right now, you can't use the nav links on mobile (on the home page) because they're hidden. As a first pass, we could just do the same thing that we do on the docs.

Document Map.filter and Map.reject

ref: grain-lang/grain#344

Document constant patterns and match guards

Document Math stdlib

After grain-lang/grain#485 lands

README: Add instructions on how to add a new blog post

Page: Difference between X (or why X instead of X)

When shown Grain, many people ask questions like "What's the difference between Grain and OCaml?" or "Why didn't you just compile OCaml to WASM?", etc etc.

I think we could have a page for why Grain exists and how it differs from OCaml/Reason/Rust/Insert-functional-language-here.

Document type annotations

Hello world

As a very beginner, I would find a "hello world" example useful.

Being able to see the results in the interactive console would also help me with a fast confirmation that my setup is OK.

Dark mode

It'd be pretty sick if there were a dark mode option for the docs.

Document type system specifics

This would be a page on what kind of type system we have, features, etc. It should live in the language constructs section (though we should consider renaming that section).

Related: #82

“Grain: Your WebAssembly-First Programming Language” video link is broken

this one works
https://www.youtube.com/watch?v=O8tyml3xBMM&list=PL6ed-L7Ni0yRnaN8-l2wfA0u3ILmyJMkz&index=6

Document List.take, takeWhile, and sub

Ref: grain-lang/grain#378

Discussion: How should we document the language itself

Currently, not much of the language itself is documented on the website. I just found Bindings today and noticed that it has a pretty plain way of representing the language constructs for let bindings.

I wonder if there's a better and more clear way for us to document the actual language.

Document Grain's operator precedence

Should largely be copying over the table from grain-lang/grain#294, but prettier.

Streamline local development

Because the docs and the blog are separate Hexo sites, there are separate commands to run the combined server. I think this can be solved using yarn workspaces.

See #87 as well.

Document List.find and List.findIndex

grain-lang/grain#348

Document changes to the number system

The changes are those made in grain-lang/grain#298.

Document destructuring

There's a very brief mention of destructuring of tuples in the Basics section of the guide, but we don't really discuss them anywhere else. We should add more thorough destructuring information, both in the guide and on the Bindings page.

Document Array.find and Array.findIndex

ref: grain-lang/grain#365

Document Exception stdlib

Document using Grain via Docker

Docs page links don't work in development

Maybe we can use something like this to determine if we're running in development (and append the necessary .html.

https://www.npmjs.com/package/hexo-env

Document Array.reduce/flatMap/every/some

Ref grain-lang/grain#455

Add discord icon/link to header and footer

Feels weird that it isn't there.

Document Queue stdlib

I just noticed we don't have this documented.

Reference to the non existant Math module

There is a reference to the math lib which doesn't yet exist under https://github.com/grain-lang/grain-lang.org/blob/master/src/guide/basics.md#number-operations