Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK]: Add all-documentations-menu WebComponent #742

Merged
merged 4 commits into from
Oct 9, 2024

Conversation

mouflondarko
Copy link
Contributor

Closes #566

For presentation purposes, all data is mocked as a static JS object

@linawolf
Copy link
Member

@mouflondarko thanks a lot for this solution! We like it very much.

I rendered a JSON containting all the manuals here: https://docs.typo3.org/h/typo3/docs-homepage/main/en-us/mainmenu.json

Is it possible to use the result of that JSON to render the menu?

@mouflondarko
Copy link
Contributor Author

@linawolf sure, the structure looks good and should work as expected. Should the WebComponent fetch this JSON client-side?

@mouflondarko
Copy link
Contributor Author

@linawolf I've introduced the change in fetching data for the menu, now it should pull current configuration from the url you provided
I noticed a CORS-related issue was already encountered in this project (for version switcher), so I did basically the same (tried to modify the original file to make "universal" proxy, but it wasn't working properly, probably due to special characters in URLs – because of limited time I just copied the existing proxy file and slightly modified it, so for local preview a file menu-proxy.php needs to be copied to Documentation-GENERATED-temp/

With the current configuration menu looks like this:
obraz
Not sure about this long column for System Extensions - I could try splitting long columns

@linawolf
Copy link
Member

linawolf commented Oct 8, 2024

I can also split the output of the System extensions in two for the JSON. that is probably faster then a CSS / JavaScript solution

@linawolf
Copy link
Member

linawolf commented Oct 9, 2024

See TYPO3-Documentation/DocsTypo3Org-Homepage#259, the columns should look better now

@mouflondarko
Copy link
Contributor Author

@linawolf I think it looks good 👍
obraz

@linawolf
Copy link
Member

linawolf commented Oct 9, 2024

I think so too, what else is needed to make it ready for review?

@mouflondarko mouflondarko marked this pull request as ready for review October 9, 2024 07:36
@mouflondarko
Copy link
Contributor Author

@linawolf I think it's ready, would appreciate a feedback

@linawolf
Copy link
Member

linawolf commented Oct 9, 2024

Looks good, I will merge, make a release and try it out in the wild

@linawolf linawolf merged commit 54382a4 into main Oct 9, 2024
7 checks passed
@linawolf linawolf deleted the task/all-documentations-menu branch October 9, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Develop a WebComponent for a central documentation menu
2 participants