[IMPROVEMENT] Improved navbar and usage of absolute links to icons using site-urls

Description

This MR improves the website layout by incorporating multiple elements: Improvement navbar:

• sizing.md, analysis.md and libraries.md are now removed from the documentation folder and placed at the sizing, analysis and libraries folder as index.md → this makes use of navbar.indexes since there is no necessity for the overview pages anymore which are directly linked now to sizing, analysis and libraries.
• added sticky tabs to keep visible while scrolling
• enabled toc.follow to follow the toc while scrolling (right side)

Related Issue(s)

None

Other Changes

Fixed download page -> was getting_started.md not getting-started.md

Screenshots/Logs

Testing Instructions

Checked locally

Developer Checklist

• Code has been tested locally.
• Minor check was conducted - seems to work properly
• Todo → major check with pipeline.

Additional Notes

Please make sure that the mkdocs site-urls plugin is installed via pipeline. I have it locally installed.

added typedocumentation label

requested review from @kristina.mazur and @alfin.johny

assigned to @ChrisRuw

nice, it is working! Wouldn't it be ideal to include the installation of the required dependency, mkdocs-site-urls, in the pipeline configuration file?

added 1 commit

• 2f68910c - updated ci configuration state (deploy) -> moved mkdoxy to Pipfile and...

Compare with previous version

Have updated the Pipfile and the .gitlab-ci.yml to install mkdocs-site-urls directly.

added 10 commits

• 2f68910c...a7d860ff - 9 commits from branch develop
• f935e35a - Merge branch 'develop' into 'documentation/site_url_links_and_improved_navbar'

Compare with previous version

Should we include the additional library into the readme? So something like: pip install mkdocs mkdocs-material mkdocs-glightbox mkdoxy mkdocs-site-urls

One small remark :)

resolved all threads

added 1 commit

• d11bc358 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

requested review from @kristina.mazur

added 11 commits

• d11bc358...c31bfddf - 10 commits from branch develop
• e1826158 - Merge branch 'develop' into 'documentation/site_url_links_and_improved_navbar'

Compare with previous version

added 1 commit

• 36a42a8d - update contribute.md using site: ... for merge-request workflow

Compare with previous version

added 1 commit

• 646b6fe2 - update merge-request-workflow layout (figure) -> removed border and width as...

Compare with previous version

approved this merge request

unapproved this merge request

resolved all threads

approved this merge request