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

Question: sync with official refpages?

Open imirkin opened this issue 3 years ago • 6 comments

I've pushed some changes to the https://github.com/KhronosGroup/OpenGL-Refpages repository, which are obviously not reflected here.

And I'm seeing a lot of small fixes in this repo which are likely not reflected in the official refpages.

Are there any thoughts on keeping the two in sync somehow?

imirkin avatar Mar 27 '22 07:03 imirkin

I would absolutely love and definitely merge any PR containing changes from the official that haven't made their way here yet. Good job on the reverse direction PR that you did.

BSVino avatar Mar 28 '22 15:03 BSVino

So what I was wondering was whether you thought it'd be practical to have an automated process consuming the OpenGL-Refpages data directly. It could be a separate tree so that you could still control the content in case of disagreement(/slowness) with the Khronos maintainers, but at least it'd be in a shared format.

I haven't really dug into the guts of the more structural docs.gl changes -- I was hoping you could perhaps opine on whether such a strategy could work, and/or suggest a way forward?

imirkin avatar Mar 28 '22 16:03 imirkin

From a technical perspective, I completely removed the header and footer of all of the pages. The diff algorithm might get confused by that but would probably be fine. But realistically, I think it would require a manual merge to get everything up to date before an automated process could hope to work ok, and I'm not sure the frequency of changes on the kronos documents merits the amount of work it'll take to set up something automated. Maybe if it's super easy for someone?

BSVino avatar Mar 28 '22 16:03 BSVino

OK, so stuff like examples/etc are all "outside" of the main .xhtml content data? I thought there were special tags/etc that were inserted, but perhaps that's done "later". If it's literally just the headers/footers, should be rather simple.

imirkin avatar Mar 28 '22 16:03 imirkin

Also, it's not so much about frequency of updates, but having a single spot where to make the updates, to avoid divergence as much as possible.

imirkin avatar Mar 28 '22 16:03 imirkin

Yes those are done outside, mostly, if I remember.

BSVino avatar Mar 29 '22 06:03 BSVino