[Docs] Document VFS

[badosu]

Basically what it says on the tin, currently we don't document any of VFS.

See: https://github.com/beyond-all-reason/spring/blob/master/rts/Lua/LuaVFS.cpp

[rhys-vdw]

NOTE: VFS.Include is an alias of require, which has to be defined in luarc.json, rather than defined inline.

See aliases here: https://github.com/beyond-all-reason/recoil-lua-library/blob/main/README.md?plain=1#L27-L31

Any other methods should be documented (and maybe these too? I'm not sure how it interacts).

[sprunk]

NOTE: VFS.Include is an alias of require

No it's not, that's just convenient fiction/approximation so that LuaLS knows how it behaves.

[badosu]

Any other methods should be documented (and maybe these too? I'm not sure how it interacts).

See https://springrts.com/wiki/Lua_VFS as an example (hopefully VFS API hasnt changed a lot?).

[rhys-vdw]

NOTE: VFS.Include is an alias of require

No it's not, that's just convenient fiction...

Yeah I know it's not actually an alias, I set it in the config. It will need to be documented for the site, but I'm not not sure how LLS will resolve the alias vs the doc comment.