search

HSF / phoenix

"Phoenix", an experiment independent web-based event display for High Energy Physics.
https://hepsoftwarefoundation.org/phoenix/
Apache License 2.0
54 stars 53 forks source link

Adapt the API docs generation script #375

Closed 9inpachi closed 2 years ago

9inpachi commented 2 years ago

Since compodoc is updated now, the way the title of API docs is handled is different. Instead of showing the title at the top left of the API docs page, there is a compodoc logo. We should update the Node.js script gen-api-docs.js to remove the code that did the replacement of the text at the top left with the Phoenix logo or adapt it to replace the compodoc logo with the Phoenix logo.

image

subho951m commented 2 years ago

Sir I think this issue has already been resolved. Are you talking about the documentation? Screenshot (1247) .

9inpachi commented 2 years ago

Hey @subho951m,

Good point. So I checked it again and this only happens in the dark theme. If you change your browser's theme to dark and compodoc picks up the settings, it uses the invert compodoc logo which is a different image from what we replace using the gen-api-docs.js script.

subho951m commented 2 years ago

@9inpachi Ok sir I will try to solve this problem. Is this issue still opened or have you solved it?

9inpachi commented 2 years ago

@subho951m It's still open.

subho951m commented 2 years ago

@9inpachi sir in my android phone if I choose dark mode + desktop site, I can see that this problem is arising. But on other hand in my pc (windows 10) chrome if I choose "auto dark mode for web content" , the problem is not arising. I am not sure what setting is different in my android mobile and this PC. Can you please help android chrome ? this is my android chrome rendering PC Chrome this is my chrome rendering Chrome settings this is my chrome setting for dark mode. can you please help what setting should I do in PC so that it matches the android.

9inpachi commented 2 years ago

The experimental settings you enabled are different than dark mode. The latest chrome I think is able to pick up the theme based on your Windows preferences. So if you have dark theme enabled on Windows, Chrome should also have it enabled. Otherwise you can try installing this theme https://chrome.google.com/webstore/detail/dark-theme-for-google-chr/annfbnbieaamhaimclajlajpijgkdblo?hl=en.

Apart from this, you should probably look up how getting the dark theme preferences work in JavaScript.

Sometimes, websites also store the theme preferences (as Phoenix does) on your first load and then even if you change the theme of the browser, the preference in the local storage prevails. You can check the local session storage in browser console to see if any option like that is set.

MASTERAMARJEET commented 2 years ago

Is this issue open? Can I give it a try?

9inpachi commented 2 years ago

Hi @MASTERAMARJEET, yes it's still open.

MASTERAMARJEET commented 2 years ago

Hello, Thanks @9inpachi. I have created to PR with a possible fix. Kindly have a look.