Time Nick Message 00:00 MTDiscord Do we have instructions for how to test local changes before pushing? 00:00 MTDiscord For this project? 00:00 rubenwardy merging in docs to dev, and also unmaintained low importance pages from the wiki 00:00 MTDiscord Yes. Or to make a PR and then check that everything works OK. 00:00 MTDiscord Well there is the Building Locally section in the readme 00:01 MTDiscord Great. 00:01 MTDiscord rubenwardy: Yes, we have issues open to track what should and shouldnt be migrated 00:01 MTDiscord How easy. Excellent. 00:02 rubenwardy https://dev.luanti.org/compiling-on-windows-using-msys2/ should be here https://github.com/minetest/minetest/tree/master/doc/compiling 00:02 MTDiscord Yes, as I just said 00:02 MTDiscord But as I also just said, that can be attended to later once initial priorities are complete 00:03 MTDiscord Side-note: Someone mentioned earlier they were a jekyll fan, and while I dont necessarily like jekyll, I am a big liquid fan. But Hugo seems to be far easier to work with than jekyll. 00:03 MTDiscord I would frankly initially have preferred to keep engine developer matters and mod developer matters largely separate. I suppose a category may suffice. 00:04 MTDiscord This is also something to cover in https://github.com/minetest/dev.luanti.org/issues/19 00:04 MTDiscord We probably want a way to filter on those, Lars. If I'm a developer and I'm searching for some engine documentation, I don't want my search results cluttered with modding guides. 00:05 MTDiscord (I was taken by surprise by the sudden merge too, btw. I had seen the issue but had not expected for it to just be implemented immediately before there was some time for discussion.) 00:06 MTDiscord I will leave a comment on the issue 00:06 MTDiscord Ive suggested that we need higher level categories in that issue; What I didn't quite make clear is that I think this current book format should be separate for each area of documentation. In other words, there should be a higher level landing page to go to game/moddev, engine dev, players, servers, which would then be formatted like we have now 00:07 MTDiscord I think celeron was investigation whats up with the doxy docs, since that may also end up here. If (when?) it does, it should definitely be under a separate engine page 00:08 MTDiscord doxygen is to engine dev docs as Lua API reference is to mod/gamedev docs 00:09 MTDiscord The Doxygen stuff is auto generated. I guess we'll see what Celeron says about it. 00:10 MTDiscord I know. And it could still fall under dev.luanti.org 00:10 MTDiscord Though while auto-generated, IIRC it hasnt been generated in a hot minute ;p 00:10 MTDiscord Oh, looks like it is up to date 00:10 MTDiscord Cool 00:11 MTDiscord Does anyone actually use it? I wonder whether it's worthwhile to keep it at all. xD 00:15 MTDiscord Wait, did minetest_docs issues get moved here? 00:15 MTDiscord Didn't know that was a thing you could do 00:18 MTDiscord The wiki.luanti.org tracker is now pinned 00:21 MTDiscord @luatic If you saw my note on LDoc, im not sure anything other than LDoc is viable 00:23 MTDiscord Of the 4 systems that exist, 3 are maintained, 2 of those have functional tooling and support, and only 1 of those supports annotations in C++ (LDoc) 00:25 MTDiscord i see, i better put my lua parser in zig to use :juanchi_face: 00:26 MTDiscord Addendum: While EmmyLua doesn't support Lua annotations in C++, we could define a meta doc file (a dummy Lua file where C++-side Lua methods are documented). It feels like a structure smell to me but it is possible IIRC. 00:39 MTDiscord Regarding LDoc vs EmmyLua I'd vote to move forward with one as a POC and have comprehensive reviews before merging, if there are concerns we can try a POC of the other for comparison. I hadn't heard of EmmyLua before today so I'll look into that. I'll also make sure there's a GitHub issue for this 00:40 MTDiscord LDoc is far easier to get started with 00:40 MTDiscord Also more mature 00:40 MTDiscord The only thing I remember about EmmyLua as a whole is that its formatter wrongly indented long strings. 00:40 MTDiscord Sounds like we start with LDoc and see if there are any critical pain points 00:41 MTDiscord EmmyLua has... issues. Which is what LuaCATS aims to solve but LuaCATS is a very young project, and their tooling is garbage. Also half the devs are Chinese so I have no idea what's going on half the time. 00:58 MTDiscord closing https://github.com/minetest/dev.luanti.org/issues/12 since https://github.com/minetest/dev.luanti.org/issues/15 is the tracking issue 00:59 MTDiscord re https://github.com/minetest/dev.luanti.org/issues/41, read a little into it. seems you can reference the front matter stuff, but only if your in a template? not sure. needs further research 01:01 MTDiscord if anyone does, they rarely if ever talk about it. see api.minetest.net talked about, the doxygen comments almost never. iirc someone mentioned that they where kinda outdated at one point. but only one person so 🤷 if they actually are or not 01:04 MTDiscord why do we have a mirror tag? 01:13 MTDiscord For stuff specifically about migrating from old to new 01:13 MTDiscord Question: Did either wiki have translations? 01:14 MTDiscord yes, but we are ignoring them as in most cases they are heavily out of date/wrong. 01:14 MTDiscord its mentioned breifly above 01:15 MTDiscord i also said something along the lines of i verified that hugo and the template both support translation, but my caring stopped there and some other multilingual person can figure it out 01:15 MTDiscord also it probably isnt worth doing any actual translation till the content is in a good base state anyways 01:15 MTDiscord The book theme does seem to support it (according to the readme) 01:16 MTDiscord mirror seems more apt for something thats duplicated than moved, but whatever. idc 01:16 MTDiscord anyways, working on https://github.com/minetest/dev.luanti.org/issues/9 now 01:17 MTDiscord I am currently figuring out how to make higher level sections 01:17 MTDiscord there is some weight param in the docs for messing with the page content ordering 01:17 MTDiscord didnt read past that 01:24 MTDiscord It was easy enough to create the mirror tag, so I went ahead and did it. Maybe it won't be that useful. 01:25 MTDiscord Hopefully the other wikis aren't also being updated anymore. The significance of those mirror issues is that we'll have things duplicated, hopefully for a short time, and there's hypothetically a risk they could get out of sync. 01:25 MTDiscord Practically the other wikis are probably dead so I don't think we really have to worry that much about the other wiki page changing. 01:30 MTDiscord merging https://github.com/minetest/dev.luanti.org/pull/58/files in a few 01:56 MTDiscord Is there a simple term that encompasses modding and gamedev? 01:57 MTDiscord programming? 01:57 MTDiscord developing? 01:58 MTDiscord what context is this for? 01:59 MTDiscord Using the Lua API 01:59 MTDiscord Modding is not accurate to encompass making games, and Game dev is not accurate to encompass modding 02:00 ShadowNinja celeron55, roleroxza: Yes, I host doxy.minetest.net. 02:31 MTDiscord Maybe just "lua-api"? 02:32 MTDiscord If we're looking at headings for the site, I'd suggest "Mods and games" 18:56 MTDiscord well I would like it to be done but I don't know one would do so in hugo 18:59 MTDiscord for my blog (uses jekyll) I just print out bold red text for missing values (e.g. a blog post with cover image but no alt text provided) so I have to fix it before I publish. but best would be if hugo has a built-in way to trigger a proper error from the layout template code that will halt generation until it is fixed 19:00 MTDiscord yes, there it is: https://gohugo.io/functions/fmt/errorf/ 19:44 MTDiscord Wait, am I understanding correctly than we can configure Hugo using Go code? 20:28 MTDiscord Hugo is written in Go, so probably, yeah 20:30 MTDiscord Ref https://github.com/minetest/dev.luanti.org/issues/40 as well 20:40 MTDiscord Someone mentioned missing AsciiDoc admonitions yesterday, note that Hugo supports AsciiDoc and mixing content formats within a single site: https://gohugo.io/content-management/formats/ Created https://github.com/minetest/dev.luanti.org/issues/59: "Hugo supports many formats, along with mixing formats. We should update this repo's guidelines to mention our preferred formats and why so that new contributors can author content with 20:40 MTDiscord confidence." 20:43 MTDiscord https://github.com/minetest/dev.luanti.org/issues/60: New contributors should know what our best practices are: Requirements for a new page to be added (e.g. required front matter) Other stuff? 20:59 MTDiscord how dangerous can the info we put on the wiki be? 21:03 MTDiscord case in point, this page on the voxelmanip wiki: https://wiki.voxelmanip.se/Custom_Fonts. it describes something that really only works by luck and will cause issues with players' settings later down the line - it is mentioned in the page that you should reset it back to the original settings on leave, and with a fallback on next join in case of crashes, but I never wrote such an implementation so someone just copying the example 21:03 MTDiscord because they want custom fonts in their game are gonna have a bad time 21:04 MTDiscord however, this method for getting pseudo-custom fonts has already been used in the wild before I even wrote this page: https://content.luanti.org/packages/luarocks/pixel_fonts/ 21:06 MTDiscord anyways I got around to reworking the development tools page: https://github.com/minetest/dev.luanti.org/pull/61 21:12 MTDiscord I don't know how merge happy I should be now. merging in 5m unless anyone has thoughts on the new categorisation 21:12 MTDiscord https://cdn.discordapp.com/attachments/926231483155378176/1318324995264614460/image.png?ex=6761e954&is=676097d4&hm=c38bb210df2f010b34855989fd017647bd186b69b80497824bd405955dcb7362& 21:14 MTDiscord I should make the blockbench bulletpoint link to the blockbench page though 21:35 MTDiscord Mixing formats is terrible practice 21:37 MTDiscord And we have admonitions via plugin now so 21:37 MTDiscord I think mark means we should write down markdown an explicit requirement for contributed pages, since hugo supports many other formats 21:39 MTDiscord The issue title lists asciidoc and "both" as possible routes 21:40 MTDiscord eh yeah 21:40 MTDiscord yeah, I don't think we should mix them 22:56 MTDiscord merging https://github.com/minetest/dev.luanti.org/pull/63 in 5m