Skip to content

Update definitions - #18

Merged
emuell merged 12 commits into
masterfrom
feature/update-definitions
Sep 25, 2026
Merged

emuell merged 12 commits into
masterfrom
feature/update-definitions

Conversation

@emuell

@emuell emuell commented Sep 23, 2026

Copy link
Copy Markdown
Member

Updates definitions, luals-docs-gen and removes auto-generated md files from the git repo.

@emuell
emuell requested a review from unlessgames September 23, 2026 14:45

@unlessgames unlessgames left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We might want to merge the latest PR on the definitions which includes relevant fixes (for a generic type for example).

@unlessgames

Copy link
Copy Markdown
Contributor

Doesn't have to happen now but it would be nice to add some build config that allows building these without having to install the pinned versions globally with cargo. For example a nix shell config or a rust bin inside generate that depends on the needed mdbook stuff and does the build (if this is possible).

@emuell
emuell force-pushed the feature/update-definitions branch from 698912e to 99d52b0 Compare September 23, 2026 19:38
@emuell

emuell commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

merged that into definitions and updated the commit here

@emuell

emuell commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

For example a nix shell config or a rust bin inside generate that depends on the needed mdbook stuff and does the build (if this is possible).

A nix config would be easy, but I don't use nix, so I can't create it.

A single rust binary quite likely won't work, because mdbook executes the preprocessors as commands.

Actually would be nice to fix the compatibility issues with the latest version of mdbook, but it just crashed without useful info here when I tried that a while ago, so I gave up.

@unlessgames

Copy link
Copy Markdown
Contributor

I've updated to the latest mdbook version, and dropped the mdbook dependencies.

  • mdbook-alerts is archived, the functionality is included in mdbook now
  • mdbook-linkcheck seems abandoned and breaking with latest mdbook, switching to the general purpose lychee crate that will probably not have this issue
  • mdbook-toc created a bunch of issues, so I've implemented the functionality in the docgen (see PR for details
  • links pointing to the API/README.md were broken in the build (because they became API/README.html but the generated page is API/index.html, the .md link can only works in the summary file, otherwise a folder link is to be used

Please do the update steps again when both the definitions and the docgen pr is merged.

@emuell
emuell merged commit e4a8e67 into master Sep 25, 2026
1 check passed
@emuell
emuell deleted the feature/update-definitions branch September 25, 2026 20:15
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.

2 participants