Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of open issues with Antora documentation #801

Closed
SaschaWillems opened this issue Sep 12, 2023 · 0 comments · Fixed by #905
Closed

List of open issues with Antora documentation #801

SaschaWillems opened this issue Sep 12, 2023 · 0 comments · Fixed by #905
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SaschaWillems
Copy link
Collaborator

SaschaWillems commented Sep 12, 2023

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
@SaschaWillems SaschaWillems added the documentation Improvements or additions to documentation label Sep 12, 2023
@SaschaWillems SaschaWillems self-assigned this Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant