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

Docs update #2655

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Docs update #2655

merged 4 commits into from
Oct 1, 2024

Conversation

og-mrk
Copy link
Contributor

@og-mrk og-mrk commented Aug 31, 2024

Type of Change

  • Documentation update

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 the docs folder. ( commit 4af694d )

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

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

@og-mrk og-mrk marked this pull request as draft August 31, 2024 06:27
@og-mrk og-mrk marked this pull request as ready for review September 29, 2024 14:00
@ChrisTitusTech ChrisTitusTech merged commit db26666 into ChrisTitusTech:main Oct 1, 2024
1 check passed
@og-mrk og-mrk deleted the docs-update branch October 3, 2024 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants