Added documentation for Github Wiki Docs

[chawinphat]

Description

Added a README file which is visible on both the Github code and wiki sections.

This file covers how the workflow mirrors the docs folder and contains links to the workflow documentation. It also provides instructions for how other contributors can add documentation and test their changes on their fork's wiki.

Examples of the documentation updates are on my fork: Code, Wiki.

I also submitted a pull request to fix a bug of the publish-wiki workflow. Those changes might need to be added first before this pull request, so the wiki can be updated accordingly.

Issues Resolved

Closes [#4267]

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f37c31c) 91.35% compared to head (acaa0a3) 91.35%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4311   +/-   ##
=======================================
  Coverage   91.35%   91.35%           
=======================================
  Files         190      190           
  Lines        6175     6175           
=======================================
  Hits         5641     5641           
  Misses        534      534           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gaiksaya]

Just some minor nits to folder paths and URLs. Looks good overall. Thanks!

[chawinphat]

Relative URLs don't work on Wiki Documentation since the root is the ./docs folder. I'll correct them in another commit soon.

edit: since the Wiki does not allow relative URLs, I think separating the documentation into two identical files might work better here. One will be displayed on the Wiki with absolute URLs while the other will be visible in the ./docs folder with relative URLs (and we can set this file to not be seen on the wiki). The relative URLs will also work within text editors and won't redirect to a web browser.

[gaiksaya]

You can remove this file since the information is already present in the readme.
OR
Keep the readme and let me point to the Home page.

Keep either one instead of duplicating.

Thanks!

[chawinphat]

Thanks for the quick reply!

My understanding of your suggestions is:

Option 1: Keep only the readme file. The readme file will not be visible on the wiki as a result of this

Option 2: Add the readme file to the wiki and the wiki's home page. The readme file must contain absolute URLs though otherwise linkchecker fails.

I am personally leaning towards option 2.

[gaiksaya]

Please go-ahead with option 2. Link checker fail can be fixed later after by-passing it once for initial commit.
Thanks!

[jordarlu]

Hi, @gaiksaya, could we have your approval once again to proceed with merging this update? Thanks!