Addition of collapsible sections, keywords cloud, switch, levels, and glossary page

PierreDillard commented 2 months ago

Changes

Addition of Glossary Tab

Before:

The documentation did not have a Glossary tab.
Before Glossary

After:

A new Glossary tab has been added to the navigation menu (in development).
After Glossary

Keywords Cloud

Before:

No keywords cloud was available.
Before Keywords Cloud

After:

A dynamic keywords cloud is displayed based on a keywords.json file. Keywords are shown according to the page visited (most common technical terms on the page (>2 and contained in the lexicon)). Clicking on a keyword opens a modal window with the definition and a "Read more" link redirects to the "keyword/glossary" page.
After Keywords Cloud (completed, but final lexicon still needed)

Collapsible Sections

Before:

Sections were not collapsible, making navigation more difficult.
Before Collapsible Sections

After:

Main titles (H2) are now in collapsible menus, allowing better visibility and quicker access to information.
After Collapsible Sections (completed for all H2 on the page)

Expertise Level Selector

Before:

No selector to choose the expertise level.
Before Expertise Level Selector

After:

Added a selector at the top left to choose the expertise level (expert or beginner). Keywords and sections displayed change based on the selected level ("Expert/Beginner"). (Howtos/filters-oneliners & Howtos/inspecting) After Expertise Level Selector (completed)

Tags on Collapsible Sections

Added an attribute directly to the markdown next to the H1 (in markdown) {: data-level="beginner" } for the "beginner" level (completed, levels yet to be chosen).

Created an "all" attribute that will be displayed regardless of the selected menu "beginner" or "expert" and will be expanded by default (e.g., "overview", "foreword" sections).

Modal Feature for Keywords

Modal feature on keyword click, displaying the definition and a "Read more" link redirecting to the keyword page. For testing, created the glossary/encode and glossary/encrypt pages.

Scroll to Top Navigation

Before:

No button to quickly return to the top of the page.
Before Scroll to Top

After:

Added an icon button that appears after scrolling, allowing immediate navigation to the top of the page.
After Scroll to Top (completed)

Additional Information

Using a dynamic URL for the JavaScript bundle caused several features to malfunction, such as the search bar and the scroll-to-top button (only in development mode via mkdocs serve).
Using <script src="{{ 'assets/javascripts/bundle.fe8b6f2b.min.js' | url }}"></script> to fix the issue.

To Do

Create the final lexicon
Create all glossary pages

PierreDillard commented 1 month ago

Hello @nlsdvl or @rbouqueau, could you please review this PR? Thanks!

nlsdvl commented 1 month ago

@PierreDillard The PR is marked as 'draft', did you mean to submit it for review for validation before merging ? or are you just looking forward to feedback at this point ?

PierreDillard commented 1 month ago

@PierreDillard The PR is marked as 'draft', did you mean to submit it for review for validation before merging ? or are you just looking forward to feedback at this point ?

Hi @nlsdvl,

Indeed, the PR is currently marked as "draft". Here is a status update on the functionalities:

Completed functionalities:

Menu collapse
Top navigation
Switch (TOC/NAV) on the left: implemented to make room for the keywords cloud
Levels (experts-beginner-all) are functional, but the sections concerned still need to be selected in the DOC (adding attributes in the Markdown)

Functionalities under development:

Keywords clouds: still needs to be implemented with a complete lexicon of keywords and adapted according to levels (experts-beginner-all)
Pages for keywords: The pages for keywords such as "encode" and "encrypt" are available for testing, but the rest are still in progress.
Glossary tab: A new tab for "Glossary" will appear in the navigation once the lexicon and all the keyword pages are completed.

For now, I would like to get feedback on the completed functionalities to validate them. Regarding the functionalities under development, I am open to suggestions or feedback that could improve their integration. So, if possible, could you please give me your feedback on the functionalities already in progress?

PierreDillard commented 1 month ago

Hi Nils, I've commented on all ongoing development features (keywords links to glossary pages,glossary tabs in yaml )

gpac / wiki