Time |
Nick |
Message |
00:12 |
|
MTDiscord joined #minetest-docs |
01:24 |
|
MTDiscord joined #minetest-docs |
03:48 |
MTDiscord |
<wsor4035> merging https://github.com/minetest/dev.luanti.org/pull/128 on the hour |
03:48 |
MTDiscord |
<wsor4035> does the basics, better writers than i can expand it |
03:54 |
MTDiscord |
<wsor4035> btw, i assume we prefer to link to api.luanti.org rather than the lua_api.md? |
03:54 |
MTDiscord |
<wsor4035> since its "nicer" |
03:54 |
MTDiscord |
<wsor4035> . |
05:00 |
|
MTDiscord joined #minetest-docs |
17:12 |
MTDiscord |
<mark.wiemer> Yeah I would go to api.luanti.org first. Do we think we'll eventually turn that into dev.luanti.org/api ? |
17:13 |
MTDiscord |
<mark.wiemer> api.luanti.org also loads faster and we have control over styles, breaking it down into multiple pages if/when we break down lua_api.md into separate files, etc. |
17:13 |
MTDiscord |
<wsor4035> .....i dont see a point to that? |
17:14 |
MTDiscord |
<wsor4035> i mean, they load about the same for me. at least on luanti scale there both blazingly fast when you compare against c55 hosted things π |
17:16 |
MTDiscord |
<wsor4035> not to mention it would be kinda messy since that site is rebuilt on every engine push (that updates lua_api.md iirc? since its generated from that) |
17:18 |
MTDiscord |
<wsor4035> a quote from me elsewhere > [snip] did wonder if api.luanti.org should be spun into its own repo, allowing some sort of build where if you visit the main site its latest master, but you could go to api.luanti.org/VERSION/doc to see the applicable docs for your versions. [snip] |
17:20 |
MTDiscord |
<rollerozxa> yeah I don't think we should move the autogenerated API reference into dev.luanti.org, it should stay separate |
17:21 |
MTDiscord |
<rollerozxa> like we shouldn't dump the several hundred megabytes of doxygen generated content that is on https://doxy.minetest.net/, it can stay on a separate subdomain |
17:22 |
MTDiscord |
<wsor4035> idk, green might want to argue with you on that one. |
17:22 |
MTDiscord |
<wsor4035> maybe not the doxygen stuff specifically, but one of the long term goals is some sort of annotations in the engine or something like that |
17:24 |
MTDiscord |
<rollerozxa> yeah, so like it would sync stuff across specific pages that we have here, kinda like how SDL does it with wikiheaders |
17:25 |
MTDiscord |
<wsor4035> no idea how sdl does wikiheader, but sure! |
17:25 |
MTDiscord |
<wsor4035> anyways, kinda topic change, we probably can archive minetest_docs repo? |
17:25 |
MTDiscord |
<rollerozxa> sounds ok |
17:27 |
MTDiscord |
<wsor4035> idk, for consensus sake, cc'ing the other relevant people @luatic @greenxenith |
17:27 |
MTDiscord |
<rollerozxa> well the summary is that they attach a function in the public API headers with a page in the sdlwiki, so when changes in the header annotation happens it syncs to the wiki and vice versa, while more elaborate details and examples get added to the wiki page and stay there |
17:27 |
MTDiscord |
<luatic> no opposition, further contributions of mine will go to dev.luanti.org either way |
17:28 |
MTDiscord |
<rollerozxa> in general doing that is a bit different from dumping automatically generated doxygen documentation into a subfolder, and I hope nobody actually wants us to do exactly that |
17:28 |
MTDiscord |
<wsor4035> ok, once green responds, will ask c55 for this since i dont have access to do so on that repo |
17:31 |
MTDiscord |
<wsor4035> making doxygen stuff build in ci like api.luanti.org might not be a bad idea |
17:31 |
MTDiscord |
<rollerozxa> yup |
17:33 |
MTDiscord |
<rollerozxa> it would need to be in a separate repo since you can only deploy one site per repo, but for principia I just made a repo that pulls for changes in a CI cron, and generates the doxygen and deploys it if there are updates |
17:33 |
MTDiscord |
<rollerozxa> https://github.com/principia-game/doxygen |
17:33 |
MTDiscord |
<rollerozxa> for luanti you'd need to generate a build folder since it uses some preprocessing for the doxyfile, but that's about it that would need to be changed |
17:35 |
MTDiscord |
<rollerozxa> (it also uses the very nice doxygen-awesome theme. with dark mode support) |
17:36 |
MTDiscord |
<wsor4035> anyways, someone would have to take the project on |
17:36 |
MTDiscord |
<wsor4035> and get shadowninja/c55 buy in |
17:37 |
MTDiscord |
<rollerozxa> yeah, of course... |
19:17 |
ShadowNinja |
Here are the scripts I use: https://gist.github.com/ShadowNinja/ae535e1589a1037d5a20125ff6c8eb32 |
19:19 |
ShadowNinja |
There's a minify step that's currently disabled because it was breaking things, but you could probably find a better minifier. Β It also optimizes svgs and generates a compressed .gz copy of each file since nginx can use that precompressed file instead of compressing on the fly. |
19:20 |
ShadowNinja |
The final doc/html directory size is about 565M. |
19:30 |
MTDiscord |
<rollerozxa> ah I see, that's fancier than I expected |
19:30 |
MTDiscord |
<rollerozxa> I did a test run of generating the doxygen for master and it measured up to about 250MB. I assume the size difference is because of the precompressed gzip files |
19:32 |
MTDiscord |
<rollerozxa> (github pages' size limit for deployments is 1GB, don't know if it's compressed or not. but that should be fine) |
19:36 |
|
Desour joined #minetest-docs |
19:52 |
MTDiscord |
<wsor4035> merging https://github.com/minetest/dev.luanti.org/pull/129 in 10, cc roller |
19:59 |
MTDiscord |
<rollerozxa> ooh, time for more redirects π |
19:59 |
|
Desour joined #minetest-docs |
20:02 |
MTDiscord |
<wsor4035> (merged) |
20:03 |
MTDiscord |
<wsor4035> people other than me can import pages btw |
20:14 |
MTDiscord |
<wsor4035> 25 more pages to go |
20:15 |
MTDiscord |
<wsor4035> https://tenor.com/view/pain-suffering-death-star-wars-gif-25111888 |