| Time |
Nick |
Message |
| 01:08 |
MTDiscord |
<sheriff_u3> https://docs.luanti.org/for-creators/development-tools/#syntax-highlightingautocompletion still calls Luanti Tools "Minetest Tools", which although was correct at the time that was likely written, is now incorrect. |
| 01:21 |
|
mrcheese joined #luanti-docs |
| 02:05 |
MTDiscord |
<wsor4035> submit a pr if you care |
| 02:58 |
MTDiscord |
<mark.wiemer> Thanks for calling this out @sheriff_u3 , created https://github.com/luanti-org/docs.luanti.org/pull/307 🙂 |
| 03:03 |
MTDiscord |
<wsor4035> you could park a bus in that gap |
| 03:04 |
MTDiscord |
<wsor4035> im hitting squash and merge on that in 5 if no one cares |
| 03:05 |
MTDiscord |
<mark.wiemer> but what if someone cares and they're not online right now? |
| 03:05 |
MTDiscord |
<wsor4035> ...then they can submit a follow up pr? its not any different than anything else |
| 03:06 |
MTDiscord |
<wsor4035> i mean, i guess you care, so will just leave it open. but its trival af |
| 03:07 |
MTDiscord |
<mark.wiemer> yeah I think the only concern is the idea that we'd be going back and forth with PRs, esp if the followup PR is also opened and merged within 5 minutes. We as a team never really came to an agreement here, but I recognize that my concern is more hypothetical than practical, esp with such a small PR like this. Happy to go with your "move fast and hope we don't break things" approach. Go ahead and merge 🙂 |
| 03:08 |
MTDiscord |
<wsor4035> ok, ill restart the 5m timer then |
| 03:08 |
MTDiscord |
<wsor4035> the idea is if your a member of the docs team, your trusted |
| 03:13 |
MTDiscord |
<mark.wiemer> I merged it, muahahaha |
| 03:14 |
MTDiscord |
<mark.wiemer> How would you feel about merging PRs without waiting 5 minutes? Obv we should always ping them here but why wait 5 minutes when we can just wait 0 minutes, you know? |
| 03:14 |
MTDiscord |
<wsor4035> more so in case someone is working on it |
| 03:15 |
MTDiscord |
<mark.wiemer> I just think a 5 minute warning is very unlikely to result in anyone responding in time |
| 03:15 |
MTDiscord |
<wsor4035> engine does 10 |
| 03:15 |
MTDiscord |
<wsor4035> that kinda where i stole the practice from |
| 03:15 |
MTDiscord |
<wsor4035> its also useful if (lol, not now), we have a lot of prs, and two people are trying to merge at the same time |
| 03:15 |
MTDiscord |
<wsor4035> avoid conflicts |
| 03:15 |
MTDiscord |
<wsor4035> just in case |
| 03:17 |
MTDiscord |
<wsor4035> besides, 5 minutes is go read a bit of an hn article or something for a few and then merge |
| 03:18 |
MTDiscord |
<mark.wiemer> I don't want to read a bit of an article, I want to merge and move on :/ does engine get a lot of reviews in their 10-minute window? I don't think we've ever gotten any feedback in our 5 minute window |
| 03:18 |
MTDiscord |
<wsor4035> sometimes, not much. its also code instead of docs |
| 03:19 |
MTDiscord |
<wsor4035> i mean, if you want to just announce that your merge stuff and then do it, go for it. your a docs member and have the right to do so |
| 03:19 |
MTDiscord |
<exe_virus> We can always merge a revert commit, which will never happen 😉 |
| 03:19 |
MTDiscord |
<wsor4035> like for conflicts, worse case is someone else coming along will see you merging and just be like, ill hold off till there done |
| 03:20 |
MTDiscord |
<wsor4035> speaking of hn, heres and article for the technical writing nerds if you care: https://rabbitictranslator.com/kde-onboarding/ |
| 03:23 |
MTDiscord |
<wsor4035> kinda reminds me that while we have docs for stuff, would like to make some of them more guides, now good luck defining that |
| 03:25 |
MTDiscord |
<mark.wiemer> Yeah that goes way back to my understanding of docs being two types: reference and guides. My basic split is that reference material shows up in IDEs, guide material doesn't. Obviously "common gotchas" are often included in reference material (and should be!) but that's where the line gets blurry. |
| 03:26 |
MTDiscord |
<mark.wiemer> Like, a grammar book teaches you the basic rules of grammar, and that's a reference. But Strunk and White's Elements of Style is a guide 🙂 |
| 05:00 |
|
MTDiscord joined #luanti-docs |
| 08:07 |
MTDiscord |
<exe_virus> Even as a professional software engineer, guides are 95% of the time what I want, even in my references, haha. |
| 09:22 |
|
Warr1024 joined #luanti-docs |
| 09:47 |
|
Warr1024 joined #luanti-docs |
| 11:38 |
MTDiscord |
<mark.wiemer> Same, but we need a good reference first to ground our guides! Elements of Style wouldn't make much sense if you didn't know where to put a semi-colon! |
| 12:17 |
|
mrcheese joined #luanti-docs |
| 12:47 |
|
Desour joined #luanti-docs |
| 16:30 |
|
Desour joined #luanti-docs |
| 18:09 |
MTDiscord |
<exe_virus> Ha, that's why you actually help the docs team and I just spitball. I'm pretty much always the 95% good enough guy and my reference documentations demonstrate that |
| 20:09 |
MTDiscord |
<luatic> References document everything there is in an organized manner, such that someone who knows what they're looking for can find out the specifics to use it. Guides give you an overview of what to look for in the first place. They tell a story of how things can be put together to achieve something. |
