Porting to github pages

[alainseys]

Description

Closes #71

porting documentation over to GitHub pages

Technical details

the documentation porting over to Github pages is pretty easy you only need to set in the project setting that you want to use the Github pages.

Set the repo that needs to be used and set the folder.
I have updated the README.md documentation file to use the documentation that is present in the repo.

Todo

If you are porting over to Github pages there needs to be a cleanup executed that removes the unused scripts / files.

Checklist

[X] My pull request targets the default branch of the repository (main or master).
[X] My commit messages follow best practices.
[X] My code follows the established code style of the repository.
[ ] I added or updated tests for the changes I made (if applicable).
[X] I added or updated documentation (if applicable).
[X] I tried running the project locally and verified that there are no
visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[brylie]

If you are porting over to Github pages there needs to be a cleanup executed that removes the unused scripts / files.

Good point. I opened up issue #96 as a continuation task to clean up the documentation files and fix a couple of bugs with the navigation.