Wiki updates #15

PierreDillard · 2024-08-07T08:13:13Z

Response to Feedback

Thank you for your detailed feedback.

Glossary tab / Keywords Cloud

The glossary tab doesn't show up in expert mode, is that expected?
- The glossary tab is currently not displaying in either "expert" or "beginner" mode. This feature is still under development and will be implemented in a future update.
Dark mode styling missing
- Dark mode styling has been addressed for collapses, keywords cloud, top navigation, and toggle button. Some updates may not be visible on dev.wiki.gpac.io as modifications were made to /overrides files outside of /doc.
Is this compatible with tags?
- Yes, it's compatible with tags. We could potentially use tags for glossary pages to make them easier to find.

Back to top

Dark mode styling missing
- Dark mode styling has been implemented for this feature.

Beginner / Expert mode

Motivation for this change
- The focus has been primarily on the "howtos" section. The intention is to allow new users to quickly access essential information.
- Detailed categorization will be discussed further with Jean.
Expert mode switch location
- The expert mode switch location has been changed to be next to the dark mode icon, although this isn't visible on dev.wiki.gpac.io due to /overrides modifications.
Content tagging and related switch
- A new document, "content-tagging-system.md", has been created at the project root to detail the tagging system's functionality.
- The default behavior has been rectified to "expert" mode, showing everything by default.
Bug on /Filters/avmix page
- This has been documented in content-tagging-system.md. It's a formatting issue when there's a code block in the markdown. The solution is to add a line break between the code block and the following line. Some pages have been fixed, but others still need attention.
Search feature issue
- A tooltip has been added to inform users that switching to expert mode is better for searching.

Collapsible content

Dark mode styling
- Dark mode styling has been implemented.
Default collapsed state
- The decision to collapse everything by default was made for better readability. However, this functionality could be limited to specific sections if it's too disruptive.
Spacing issue
- The spacing issue between the title and the permalink button has been fixed.
Safari desktop issue
- The issue couldn't be reproduced. More information about specific pages where this occurs would be helpful.

Switch (TOC/NAV) on the left

Reason for change
- This change was primarily made to accommodate the keyword cloud.
User understanding
- The icon has been changed and a tooltip added to inform users about the ability to switch between TOC and nav. These changes are not yet visible on dev.wiki.gpac.io due to needed /overrides modifications.

Git related feedback

Force push and file modifications
- The git issues have been resolved by starting with a new branch.

…tainer near dark mode icon

- Relocated the Table of Contents (TOC) to the right side of the UI - Added a settings icon to the interface - Implemented a dropdown menu with options to configure settings: - Collapse TOC - Adjust TOC levels - Toggle dark mode

PierreDillard · 2024-09-23T13:53:42Z

Main Updates:

Restored the Table of Contents (TOC) on the right side of the page.
All collapsed menus are now opened by default.
Added a new "Settings" menu in the header to allow users to personalize their experience:
- Expert/Beginner option: By default, the experience is set to "Expert."
- Collapse menus: Menus are expanded by default.
- Dark mode settings.

In the Filters and MP4 box :
- In Expert mode, all filter options are visible.
- In Beginner mode, only the "basic" options are displayed.

PierreDillard · 2024-09-23T13:55:42Z

Hey @nlsdvl,

I hope you're doing well! When you have a moment, could you please review the updates in this PR? I've restored the Table of Contents, adjusted the menu settings, and added a few customization options. Any feedback would be greatly appreciated !

- Resolved issues with the collapse icons on the left sidebar. - Improved the navigation behavior related to icon collapsing.

- Changed the modal behavior to trigger on mouse hover rather than on click.

- Moved the modal to the left of the screen. - Adjusted the modal to be horizontally centered as well.

- Wrap logic in try...catch blocks to handle unexpected errors

- Modal now opens just above the keywords - Filters display dynamically based on the level - Added linear gradient to the modal and collapsible elements - Added Command operations section to the mkdocs.yml file

…i-updates

jeanlf · 2024-10-18T13:16:39Z

when merging this, we'll have to merge https://github.com/gpac/gpac/tree/buildbot-hintclass

nlsdvl · 2024-11-06T14:32:17Z

@jeanlf - I would like to merge this.

I assume the Filter's documentation was generated from that branch : https://github.com/gpac/gpac/tree/buildbot-hintclass

I've opened a PR with the changes in gpac supporting this wiki update: gpac/gpac#3025
We need to merge it before #7 can be automated.

@PierreDillard - thanks for all the work one this and taking into account everybody's feedback.

jeanlf · 2024-11-06T18:57:29Z

@nlsdvl could you rebase first ? I'll merge everything once done

jeanlf · 2024-11-07T06:11:06Z

all merged !

PierreDillard added 20 commits August 5, 2024 10:05

updates levels, keywords-cloud, modal

fc5c72f

add content-tagging-system.md

537e2ab

update content-tagging-system.md with spacing between code blocks

4a033ce

tagging howtos section

d855f73

improve toggle button style

c7cc8c3

add tooltips for switch level and search function/move the switch con…

591b1b9

…tainer near dark mode icon

tagg Howtos section

894ee9f

add margin on md-typeset mark

df8d1ee

fix md in filters_general

0ee60b4

fix format error .md(code blocks) on Howtos

21ca778

fix format error .md(code blocks) on MP4BOX

4272cb4

fix format error .md(code blocks) on GPAC section

618edb9

Fix Format error .MD and collapse in Build,XML,Player sections

d0d29c3

add Glossary/sink, Glossary/source

cfe2868

add custom 404

d236b64

fix 404 template

910e5b6

add codec, bitrate & transcode in /glossary

9315dea

improve md format in encode.md, sink.md

1b55eb4

improve bitrate, codec, sink && source

8600e73

PierreDillard and others added 8 commits September 24, 2024 11:38

fix nav-items display

d9687ef

Fix sidebar collapse icons for navigation

38a1643

- Resolved issues with the collapse icons on the left sidebar. - Improved the navigation behavior related to icon collapsing.

Updated modal to open on hover instead of click

722d92b

- Changed the modal behavior to trigger on mouse hover rather than on click.

update modal position

a7650d5

Adjust modal position for centered alignment

93a2acd

- Moved the modal to the left of the screen. - Adjusted the modal to be horizontally centered as well.

Add error handling to event listeners and modal functions

1f95023

- Wrap logic in try...catch blocks to handle unexpected errors

fix modal width

db8d373

Delete changements_diff_origin.txt

b299e66

PierreDillard added 2 commits October 11, 2024 16:48

Improve modal behavior and dynamic filter display

7993638

- Modal now opens just above the keywords - Filters display dynamically based on the level - Added linear gradient to the modal and collapsible elements - Added Command operations section to the mkdocs.yml file

Merge branch 'wiki-updates' of github-pro:PierreDillard/wiki into wik…

393e68b

…i-updates

nlsdvl mentioned this pull request Nov 6, 2024

Buildbot hintclass gpac/gpac#3025

Merged

Merge branch 'master' into wiki-updates

f4146ed

jeanlf approved these changes Nov 7, 2024

View reviewed changes

jeanlf merged commit 8debea4 into gpac:master Nov 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wiki updates #15

Wiki updates #15

PierreDillard commented Aug 7, 2024

PierreDillard commented Sep 23, 2024 •

edited

Loading

PierreDillard commented Sep 23, 2024

jeanlf commented Oct 18, 2024

nlsdvl commented Nov 6, 2024

jeanlf commented Nov 6, 2024

jeanlf commented Nov 7, 2024

Wiki updates #15

Wiki updates #15

Conversation

PierreDillard commented Aug 7, 2024

Response to Feedback

Glossary tab / Keywords Cloud

Back to top

Beginner / Expert mode

Collapsible content

Switch (TOC/NAV) on the left

Git related feedback

PierreDillard commented Sep 23, 2024 • edited Loading

Main Updates:

PierreDillard commented Sep 23, 2024

jeanlf commented Oct 18, 2024

nlsdvl commented Nov 6, 2024

jeanlf commented Nov 6, 2024

jeanlf commented Nov 7, 2024

PierreDillard commented Sep 23, 2024 •

edited

Loading