You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With PRs #799 and #800 the Antora documentation for the samples is pretty much ready for release.
This is a meta issue to track remaining issues with the documentation part of the samples.
I noticed a few issues though that we need/should address at some point:
Source file links in the framework documentation don't work
Images for the hpp samples aren't displayed, probably because they have relative links that afaik won't work with Antora (Texture mipmap generation, pipeline cache, swapchain images)
Formatting for some of the hpp sample readmes is off because of wrong indentation levels (=== before =) Fixed with PR Documentation format fixes #808
Screenshot for the dynamic line rasterization sample is not displayed
Some of the internal links between pages in the project aren't working (see output when building the site)
We have a lot of links to the spec registry, which should be changed to link to the docs site spec project instead
Some files have explicit table of contents (e.g. the build guide), which won't work with antora and is also not necessary, as antora always shows a table of contents at the right hand side of a page Fixed with PR Documentation format fixes #808
Some inter-documentation links are broken, e.g. in the readme for the "Appropriate use of render pass attachments" sample
The text was updated successfully, but these errors were encountered:
With PRs #799 and #800 the Antora documentation for the samples is pretty much ready for release.
This is a meta issue to track remaining issues with the documentation part of the samples.
I noticed a few issues though that we need/should address at some point:
Formatting for some of the hpp sample readmes is off because of wrong indentation levels (=== before =)Fixed with PR Documentation format fixes #808Some files have explicit table of contents (e.g. the build guide), which won't work with antora and is also not necessary, as antora always shows a table of contents at the right hand side of a pageFixed with PR Documentation format fixes #808The text was updated successfully, but these errors were encountered: