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.
Type of Change
Description
Fixes the warnings shown in every run about documentation files not added directory to nav bar, this was caused every since PR #2481 was merged. ( commit d2b3af9 )
Tries to fix assets (images) referencing in.github/CONTRIBUTING.md
File, where the Image Previews are broken on GitHub.. but work fine on Documentation website, a good fix for this is Symbolic Links (A hard or soft one), tried a Soft Link for Directory.. GitHub failed to process it when previewing images (which's the reason behind the symbolic link), then I tried Hard Links for Directory (known as Directory Junction on Windows), and it works quite well.. but not sure if it'll work on others machine, as I'm not familiar with Git & Hard Links :/ . ( commit 8fb9543 )This idea was abandoned due to not finding a good reason to add complexity to docs build system for a small issue like images not showing, specifically on GitHub.. so the solution is to move the entire file from
.github
folder to thedocs
folder. ( commit 6845cfd )Testing
Ran the GitHub Pages Deploy workflow manually, and it works as expected with zero warnings/errors. ( link to the run )
Impact
Beside the fix for
.github/CONTRIBUTING.md
image previews.. there shouldn't be any other effect on Developers & End-users alike.Additional Information
not_in_nav
OptionChecklist