Skip to content
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

Update website and zine (Zig 0.13) and fix broken links #229

Merged
merged 4 commits into from
Sep 25, 2024

Conversation

MatthiasPortzel
Copy link
Contributor

@MatthiasPortzel MatthiasPortzel commented Aug 1, 2024

  • Updates Zine for Zig 0.13
    • Frontmatter format changed to zon from JSON
    • Requires valid HTML—no self closing tags
  • Updated broken links
    • regz and uf2 now point to the monorepo folder
    • Dropped the extension from the "Getting Started" link, that's now fixed
    • The Getting Started page needed some absolute links to assets since it's now a folder not a top-level file
    • Updated the ziglings link to point to Codeberg
  • Deleted the "legacy-ssg" folder (hopefully that wasn't still needed)

@MatthiasPortzel
Copy link
Contributor Author

@EliSauder I think this duplicates some work you did previously, does this look right?

Copy link
Contributor

@EliSauder EliSauder left a comment

Choose a reason for hiding this comment

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

The only last thing other than the other comments, is the layout files should be moved to .shtml over .html as that is the file extension kristoff chose for the SuperHTML templating language.

Comment on lines +7 to +8
.url = "git+https://github.com/kristoff-it/zine#e21b179b78de54ab48efe38d2378e87a56cb3542",
.hash = "1220781f118454bbc87d7efbd244b4d1ef029e76a6113ddf4752a6f3cd85879dbb3b",
Copy link
Contributor

@EliSauder EliSauder Aug 1, 2024

Choose a reason for hiding this comment

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

I would suggest going with the tagged release since kristoff has made one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't understand the Zig package system to know what advantage we get from using a different URL.

Copy link
Contributor

Choose a reason for hiding this comment

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

The main version is using a well defined release version that the library creator has determined is good to go rather than a specific commit. If we want to stick with a commit that is alright, I just think using explicit versions tends to make more sense to me. Using zon, you can do something like ...#v0.4.1 as the # just expects a particular git ref.

website/content/getting-started.md Outdated Show resolved Hide resolved
website/content/tutorials/02-embedded-programming.md Outdated Show resolved Hide resolved
@EliSauder
Copy link
Contributor

Also this won't automatically deploy to the website yet since the workflows are broken (what I've been working on updating). So this should probably wait until that gets merged in to main.

@EliSauder
Copy link
Contributor

Also also, we probably want to wait for the asset system redesign that kristoff is working on (should be done somewhat soon).

@EliSauder
Copy link
Contributor

Resolves ZigEmbeddedGroup/website#13

@ikskuh
Copy link
Contributor

ikskuh commented Aug 2, 2024

Nice work!

@EliSauder EliSauder mentioned this pull request Sep 23, 2024
20 tasks
@ikskuh
Copy link
Contributor

ikskuh commented Sep 24, 2024

@EliSauder: Merging this should be fine with your changes, right?

@EliSauder
Copy link
Contributor

Yeah, i just rebased some of the changes so there shouldn't be any conflicts.

@EliSauder
Copy link
Contributor

@ikskuh the only remaining concern for the website is that zine has been updated. But we could have that be its own PR.

@ikskuh ikskuh merged commit 51173df into ZigEmbeddedGroup:main Sep 25, 2024
3 checks passed
@ikskuh
Copy link
Contributor

ikskuh commented Sep 25, 2024

@ikskuh the only remaining concern for the website is that zine has been updated. But we could have that be its own PR.

Yeah, sounds like a good idea :)

@MatthiasPortzel MatthiasPortzel deleted the website-update branch September 25, 2024 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants