Skip to content

feat: Backport doc improvements for 0.7 #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2025

Conversation

spotandjake
Copy link
Member

@spotandjake spotandjake commented Apr 19, 2025

As we have decided to hold the new website for a little bit, I figured it would make sense to backport a few of the documentation improvements and fixes to the current version.

Changes:

  • On Release we now clean the stdlib docs
    • This gets rid of removed modules ImmutableMap
  • Add the missing Range datatype
  • Mention node v22 over v16 as we're upgrading
  • Correct some 0.5 syntax that was missed
  • Update the cli options table

One additional note is the asdf release still points to 0.4.6 but I'm waiting until we decide how to handle it with the v2 version before updating (Our release process won't update that).

This is on hold until the next release because of the v22 note.

Verified

This commit was signed with the committer’s verified signature.
spotandjake Spotandjake
As we have decided to hold the new website for a little bit, I figured it would make sense to backport a few of the documentation improvements and fixes to the current version.

Changes:
* On Release we now clean the `stdlib` docs
  * This gets rid of removed modules `ImmutableMap`
* Add the missing `Range` datatype
* Mention node `v22` over `v16` as we're upgrading
* Correct some `0.5` syntax that was missed
* Update the cli options table
Copy link

netlify bot commented Apr 19, 2025

Deploy preview ready! 🌾

Name Link
🔨 Latest commit 3f5a75b
🔍 Latest deploy log https://app.netlify.com/sites/grain-lang/deploys/68032c8fbd733800086ffcbf
😎 Deploy Preview https://deploy-preview-395--grain-lang.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines +18 to +19
rm -rf ./src/stdlib/*/
rm -rf ./src/stdlib/*.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this a package.json script instead? This may require rimraf or something of the like.

Copy link
Member Author

@spotandjake spotandjake Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this makes a lot of sense, just because we don't have any matching scripts to generate the stdlib docs in the package.json we would only have cleanStdlibDocs or something.

(This will also only be around for a little while until we merge v2)

@ospencer ospencer merged commit 75a8c64 into grain-lang:main Apr 27, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants