Manual links are unstable

[tomodachi94]

Hello!

Unfortunately, links to the manual are unstable and sometimes change.

For example, before #1316, https://just.systems/man/en/chapter_18.html was a link to the section called "Other Editors", but it now links to "Micro". This happened in quotidian-ennui/quotidian-ennui.github.io#11, for example.

Thank you for this awesome project ❤️

[casey]

Ahh, that's annoying. I'm not sure it can be fixed though, since the docs are generated by mdbook, which uses chapter numbers instead of names in URLs. One thing you might try is linking directly to the readme. It has the same content, but the fragment links are based on the heading, and so should be more stable. For example:

https://github.com/casey/just?tab=readme-ov-file#other-editors

[laniakea64]

I'm not sure it can be fixed though, since the docs are generated by mdbook, which uses chapter numbers instead of names in URLs.

But other sites generated with mdbook don't have this issue, e.g. https://rust-lang.github.io/mdBook/ and https://gtk-rs.org/gtk4-rs/stable/latest/book/
How are they solving it?

Could this issue with just.systems actually stemming from code in https://github.com/casey/just/tree/master/crates/generate-book ?

[casey]

Whoops, you're totally right! Let me see if I can fix that.

[tomodachi94]

Maybe it could be as simple as replacing calls to number with calls to slug?

just/crates/generate-book/src/main.rs

Line 79 in a440a6a

fn slug(s: &str) -> String {

[casey]

Fixed in #2372! I can't probably that they'll be permanently stable, since chapter titles can still change, but they should be much more stable.