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

Docs: Add favicon everywhere #87

Merged

Conversation

louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Jan 24, 2024

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Related to #15.

Description

Adding a favicon file and use it everywhere.

Motivation & Context

The documentation had no favicon.

Types of change

  • New feature (non-breaking change which adds functionality)

Test checklist

Please check that the following tests projects are still working:

  • docs/examples
  • test/angular-ngx-echarts
  • test/angular-tour-of-heroes
  • test/html
  • test/react
  • test/vue
  • test/examples/bar-line-chart
  • test/examples/single-line-chart
  • test/examples/timeseries-chart

Copy link

netlify bot commented Jan 24, 2024

Deploy Preview for ods-charts ready!

Name Link
🔨 Latest commit 48ed5a3
🔍 Latest deploy log https://app.netlify.com/sites/ods-charts/deploys/65b9e7483748740008d12a5a
😎 Deploy Preview https://deploy-preview-87--ods-charts.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@julien-deramond

This comment was marked as resolved.

@louismaximepiton
Copy link
Member Author

Should work properly on examples side.
I had to introduce relative path since the URL differs between local and netlify. Should I fix this as well ?
Idk if you want it on API side as well but we might need https://www.npmjs.com/package/typedoc-plugin-extras as an extra plugin ?

Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @louismaximepiton
I've just made minor modifications in the NOTICE.txt file via 96c8de0 and a0896ee.
I noticed that <meta name="theme-color" content="#000"> was missing; added via 48ed5a3.

Should work properly on examples side.
I had to introduce relative path since the URL differs between local and netlify. Should I fix this as well ?

Let's let it as you've done it in the PR. It works well in Netlify deployment pages but also locally. We'll revisit later on if needed :)

Idk if you want it on API side as well but we might need https://www.npmjs.com/package/typedoc-plugin-extras as an extra plugin ?

Let's do that in a separate PR. Based on that, I've removed the link to the issue (this PR won't close it) and I'll create a sub-list of tasks in the issue to show that the only remaining thing will be that: adding favicons to the /api URL.

LGTM so :shipit:

@julien-deramond julien-deramond added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 31, 2024
@julien-deramond julien-deramond merged commit 859e69f into Orange-OpenSource:main Jan 31, 2024
4 checks passed
@louismaximepiton louismaximepiton deleted the main-lmp-favicon branch January 31, 2024 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants