docs.gl icon indicating copy to clipboard operation
docs.gl copied to clipboard

docs.vk for Vulkan?

Open Narann opened this issue 10 years ago • 7 comments

I was wondering. As Vulkan specs are now released, is there any hope to have the same documentation layout used for docs.gl but for vulkan, like docs.vk?

docs.gl is my number one OpenGL reference for many reasons and I would love to have the same for Vulkan.

Keep the good work.

Narann avatar Feb 17 '16 18:02 Narann

Just to add in my thoughts here, with Vulkan we have the opportunity to do things "right" from the start, rather than fragmenting things.

The manpages are already available for pull requests in Khronos's official repository, so it would be better for @BSVino to try and work with Khronos to bring the improved layout and interface to match the docs.gl improvements to the official pages.

baldurk avatar Feb 17 '16 19:02 baldurk

I would prefer Khronos focus on writing doc easily parsable (xml?) instead of user-formated (which is a matter of taste that will change for the next decades). This would allow a lot of interesting application (doc directly in IDE etc...).

So roughly: Khronos provides easily parsable doc letting a good place for end user application innovation (docs.vk, doc in IDE, etc...). This way, they would even not have to provide a web based version (saving a lot of their precious resources) but only "push" for nice open source initiatives (docs.vk, etc...).

My 2 cts.

Narann avatar Feb 17 '16 19:02 Narann

I don't imagine I'll be using Vulkan very much as I'm not a rendering programmer for a large studio. So, my motivation to spend time on a docs.vk isn't so great.

That said, if someone else wanted to take the reigns and own it, building a docs.vk using the docs.gl framework, I would help.

BSVino avatar Feb 18 '16 03:02 BSVino

I've personally since day one thought about and even worked a bit on, creating a site like docs.gl but for Vulkan. But I have my concerns, about the point of it as Khronos has already supplied a bunch of simple and easy to access documentation.

Also talking about domain names. ".vk" is out of the question, as it doesn't exist.

vallentin avatar Mar 17 '16 16:03 vallentin

How about vulk.an?

JesseTG avatar Mar 17 '16 18:03 JesseTG

That's actually a great idea @JesseTG, the only problem for me though, is that my webhost does not support/offer it, and I really want to keep all my hosting at the same service.

vallentin avatar Mar 19 '16 11:03 vallentin

top level domains are much more flexible these days, you may be able to acquire .vk by itself.

ratchetfreak avatar Mar 10 '17 20:03 ratchetfreak