mergiraf/mergiraf

Fork 45

docs: Further improvements to the tutorial to add a language #597

Merged

wetneb merged 2 commits from doc_updates into main

2025-09-30 14:21:52 +02:00

wetneb commented

2025-09-17 13:38:26 +02:00

Owner

Adds some documentation for the newly-introduced language profile fields
Splits the tutorial into multiple pages to make it more digestible

* Adds some documentation for the newly-introduced language profile fields * Splits the tutorial into multiple pages to make it more digestible

wetneb added 2 commits

2025-09-17 13:38:27 +02:00

doc: Document flattened_nodes and comment_nodes attributes 6f49ba46f2

To be completed by a documentation of the bundling heuristics.

doc: Split tutorial into multiple pages

/ test (pull_request) Successful in 38s

Details

0095427bb0

ada4a added 2 commits

2025-09-17 15:43:57 +02:00

Put the pages of tutorial under the same directory c4d0643314

Gives the file structure a bit more.. structure

Remove duplicate section

/ test (pull_request) Successful in 40s

Details

491402cb39

"Getting started" is the same file as "Adding a new language" -- we
should keep only of those. I went with the latter, because we need some
contents for the main tutorial page

ada4a commented

2025-09-17 15:44:51 +02:00

Owner

I wanted to make some suggestions, but thought I might as well turn them into commits... Let me know what you think about them

wetneb commented

2025-09-17 15:46:01 +02:00

Author

Owner

Thank you!

One downside I see with creating a directory is that we're breaking the link to the existing tutorial. If we want to go down that route, it would be good to set a redirect for it. I couldn't find a feature for this in mdbook sadly.

Thank you! One downside I see with creating a directory is that we're breaking the link to the existing tutorial. If we want to go down that route, it would be good to set a redirect for it. I couldn't find a feature for this in mdbook sadly.

ada4a commented

2025-09-17 15:49:34 +02:00

Owner

One downside I see with creating a directory is that we're breaking the link to the existing tutorial.

Oh, you're totally right! I think a way around that would be to keep the original adding-a-language.md file where it was, and only add its subpages into the directory -- kind of similar to Rust's module system^^

> One downside I see with creating a directory is that we're breaking the link to the existing tutorial. Oh, you're totally right! I think a way around that would be to keep the original `adding-a-language.md` file where it was, and only add its subpages into the directory -- kind of similar to Rust's module system^^

ada4a force-pushed doc_updates from 491402cb39 to 78a8411d88

2025-09-17 15:50:36 +02:00

Compare

wetneb commented

2025-09-30 14:21:42 +02:00

Author

Owner

Works for me!