-
Notifications
You must be signed in to change notification settings - Fork 9
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
Tutorial helper scripts #224
base: main
Are you sure you want to change the base?
Conversation
Todo: 1. Test scripts and verify them. 2. make tutorial lua code react according to the new system 3. Test and verify new tutorial system
I still think longterm we should maintain the tutorial in markdown, but for now why not. It does solve the problem. Note that this is actually any Python 3.6 or greater because of the format strings. Usually you want to do two things: start a script with That said I don't really care and if it ever comes to matter I can just do it for you later. The place it could matter is whenever we double down more on CI. Consider this approved or whatever, I just spotted it and it seemed worth dropping in. I haven't validated the script changes; I'm assuming that you tested, they work, and we'll find bugs later. |
Added description to explain the intent for this draft PR. |
If we have markdown to tutorial aren't the others irrelevant? We'd convert to markdown once, which is basically just some find/replace in vscode, right? Then after that we'd just always go md->cfg and the other scripts become useless? Might as well only maintain one if we can. I'd suggest scoping this such that the conversion happens in this PR< this PR lands as a deleter of the other scripts, and we can just not bother being super paranoid/etc about the new ones because there'd only be the one to review. |
I suppose that markdown editing will be unequivocally easier so yes, the end goal might as well be keeping only the markdown to cfg script. The only place where cfg has an advantage is keeping track of chapter lengths to see if you crossed 99. I suppose one can quickly open and close the cfg to check that. Therefore yeah, when the third script is good to go we can remove the other two or at least not advertise them. |
Well as I've said before if that genuinely becomes a problem (it won't, 99 markdown paragraphs is a whole novella) then we can query that from the cfg I am reasonably sure. I kind of care which way we go, because markdown is easier, but the most important thing is that we have one authoritative copy. My idea for markdown is heading levels for chapters and steps and then paragraphs under those. Bit tricky to parse without a library. There are libraries, but I only know the Rust landscape. |
I agree on the headings and paragraphs, as that is already what we do in the tutorial transcript. |
Adding scripts for making it easier to edit the tutorial files:
The PR also includes changes to the tutorial structure: