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

Payload 3 favicon #8887

Closed
thgh opened this issue Oct 28, 2024 · 4 comments
Closed

Payload 3 favicon #8887

thgh opened this issue Oct 28, 2024 · 4 comments
Labels
created-by: Contributor documentation Improvements or additions to documentation

Comments

@thgh
Copy link
Contributor

thgh commented Oct 28, 2024

Documentation Issue

https://payloadcms.com/docs/beta/admin/metadata#icons

Typescript expects url
Docs suggest href

{
  // ...
  admin: {
    meta: {
      title: 'My Admin Panel',
      description: 'The best admin panel in the world',
      icons: [
        {
          rel: 'icon',
          type: 'image/png',
-          href: '/favicon.png',
+          url: '/favicon.png',
        },
      ],
    },
  },
}

Additional Details

Couldn't find a way to set the favicon, so maybe it's not docs but code issue after all.

@thgh thgh added the documentation Improvements or additions to documentation label Oct 28, 2024
@akhrarovsaid
Copy link
Contributor

akhrarovsaid commented Oct 28, 2024

Hey @thgh,

Yeah, this seems like a docs issue. You can see the types for IconConfig directly from the source here. And you can see the next package use it in action here.

EDIT: I've opened a PR that adjusts the docs and fixes another issue in them on that page: See PR.

jmikrut pushed a commit that referenced this issue Oct 28, 2024
… table (#8898)

<!--

Thank you for the PR! Please go through the checklist below and make
sure you've completed all the steps.

Please review the
[CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md)
document in this repository if you haven't already.

The following items will ensure that your PR is handled as smoothly as
possible:

- PR Title must follow conventional commits format. For example, `feat:
my new feature`, `fix(plugin-seo): my fix`.
- Minimal description explained as if explained to someone not
immediately familiar with the code.
- Provide before/after screenshots or code diffs if applicable.
- Link any related issues/discussions from GitHub or Discord.
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Fixes #

-->
### What?
Updates the examples in the
[admin/metadata#root-metadata](https://payloadcms.com/docs/beta/admin/metadata#root-metadata)
and
[admin/metadata#icons](https://payloadcms.com/docs/beta/admin/metadata#icons)
sections from using `href` to `url` and fixes the way that the `images`
Type excludes the description due to `|` being parsed as column
separator

### Why?
As of right now, the examples are incorrect and the `images` type bleeds
into the description and omits it entirely

See image of table issue at `images`:

![image](https://github.com/user-attachments/assets/086dc44c-5c1b-4b5e-9658-521eb60fff0d)

### How?
Changes to `metadata.mdx`

Fixes #8887

Credit to @thgh for the `href` to `url` find
@paulpopus
Copy link
Contributor

The above has been merged, thanks both!

Copy link

🚀 This is included in version v3.0.0-beta.120

Copy link

This issue has been automatically locked.
Please open a new issue if this issue persists with any additional detail.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Contributor documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants