Convert markdown documentation to asciidoc #765
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note: This will break with copyright checks, as a lot of files have changed. I don't want to change copyright in all these files, so if we decide to merge we should just ignore failing copyright checks. |
JoseEmilio-ARM
previously approved these changes
Jul 31, 2023
gpx1000
previously approved these changes
Jul 31, 2023
tomadamatkinson
previously approved these changes
Aug 1, 2023
asuessenbach
previously approved these changes
Aug 2, 2023
| A sample must consistently apply a single code style. | ||
|
|
||
| A `.clang-format` file is included with this repository, please use `clang-format -style=file` to verify the code style. | ||
| Ensure that you are using clang-format 8. |
There was a problem hiding this comment.
Is clang-format 8 still the correct version?
There was a problem hiding this comment.
Not sure. This is just a conversion (and some minor fixes) of the current documentation. If this is outdated it would be best to fix it with the current markdown and I'll merge that change.
There was a problem hiding this comment.
15 is the correct version. We should do a documentation pass separate to this PR
This doesn't change anything in how the readmes are displayed in github, but it makes antora documentation generation easier
SaschaWillems
dismissed stale reviews from asuessenbach, tomadamatkinson, and gpx1000
via
6da06f6
This doesn't change anything in how the readmes are displayed in github, but it makes antora documentation generation easier
This doesn't change anything in how the readmes are displayed in github, but it makes antora documentation generation easier
This doesn't change anything in how the readmes are displayed in github, but it makes antora documentation generation easier
This doesn't change anything in how the readmes are displayed in github, but it makes antora documentation generation easier
asuessenbach
previously approved these changes
Aug 3, 2023
asuessenbach
approved these changes
Aug 7, 2023
tomadamatkinson
approved these changes
Aug 8, 2023
gpx1000
approved these changes
Aug 14, 2023
41 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR converts all markdown documentation files of our repo to asciidoc (third_party modules etc. are excluded). There are no changes to the general structure or contents, so this is mostly a 1:1 to change that most users won't notice. The PR does fix a few broken links from master, does some minor markup and formatting fixes and changes some image links to be better suited for the Antora documentation project. There are only slight visual changes due to differences in the github asciidoc renderer.
This conversion is a base for getting the samples into the Vulkan documentation site.
Fixes #693
General Checklist:
Please ensure the following points are checked:
Note: The Samples CI runs a number of checks including: