NervosEducationHub / EducationHubArticles

https://www.nervos.org/knowledge-base
2 stars 12 forks source link

Author displays incorrectly #29

Open matt-nervos opened 1 year ago

matt-nervos commented 1 year ago

I believe the syntax in this file is correct but authors are not formatted properly when rendered on the Knowledge Base

https://raw.githubusercontent.com/NervosEducationHub/EducationHubArticles/main/nervosdao_withdrawal_process_explained/index.md

image
Keith-CY commented 1 year ago

Tracked by https://github.com/Magickbase/nervos-official-website/issues/192

Keith-CY commented 1 year ago

Fixed by https://github.com/NervosEducationHub/EducationHubArticles/commit/cc293717e25085c5c3be64afc5ba548c959a7a2b

The metadata of an article follows YAML's syntax, so a whitespace is required between - and item

image image

matt-nervos commented 1 year ago

thanks @Keith-CY . I wanted to check if there was a way to display (or just to access) the multiple authors' names? Right now I see the 2 identicons but there's no way to find the second author

Keith-CY commented 1 year ago

thanks @Keith-CY . I wanted to check if there was a way to display (or just to access) the multiple authors' names? Right now I see the 2 identicons but there's no way to find the second author

It's designed to show the first author followed by etc.(https://github.com/Magickbase/nervos-official-website/blob/develop/src/pages/knowledge-base/index.page.tsx#L115)

And I didn't see the UX of author list at https://www.figma.com/file/NuMAXnrvH4SQVRJfuZhZVw/Nervos.org-R3?type=design&node-id=3477-33699&t=NQUhHadBSU9OElcE-0. Do we have a discussion about how to expand authors? @WhiteMinds

matt-nervos commented 1 year ago

@WhiteMinds just want to follow up on this one

WhiteMinds commented 1 year ago

@WhiteMinds just want to follow up on this one

Sorry for coming late, as I didn't receive an email about this mention (probably due to some of my GitHub settings).

I have reviewed the previous discussion, and we do lack a design draft for multiple authors. The previous solution was just a temporary one I wrote. We discussed it on Discord: https://discord.com/channels/@me/1074822398941085746/1094875620963528715

matt-nervos commented 1 year ago

thanks @WhiteMinds , appreciate you checking. Is there any way you can see to make their names viewable?

WhiteMinds commented 1 year ago

thanks @WhiteMinds , appreciate you checking. Is there any way you can see to make their names viewable?

Need designers to provide solutions for display

matt-nervos commented 1 year ago

can we add a mouse over that displays the names?

Keith-CY commented 1 year ago

can we add a mouse over that displays the names?

How about the avatar group as https://codepen.io/scp-nm/pen/rNVKBVO image

Or using a fluent design(https://react.fluentui.dev/?path=/docs/components-avatargroup--default)

image

matt-nervos commented 1 year ago

yea i think either of these would work @Keith-CY

Keith-CY commented 1 year ago

yea i think either of these would work @Keith-CY

Sure, we'll start this work

Keith-CY commented 1 year ago

yea i think either of these would work @Keith-CY

Sure, we'll start this work

Design is ready at https://www.figma.com/file/6XNoimRDbFTTNm016rbIdU/Magickbase?type=design&node-id=22063-22333&mode=design&t=QVukDjtD0TrhNv05-0

Ref: https://github.com/Magickbase/visual-style-guide/issues/29#issuecomment-1657759880

matt-nervos commented 1 year ago

@Keith-CY design looks good to me, can you share how we should update the descriptions and include the appropriate links?

Keith-CY commented 1 year ago

@Keith-CY design looks good to me, can you share how we should update the descriptions and include the appropriate links?

The description of the author is not covered in the design, but we can add it if necessary.


The metadata of the markdown file follows the yaml syntax(https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html), so an object is valid in the author list, e.g.

title: Nervos DAO — Withdrawal Process Explained
coverImage: images/image1.png
category: popular
date: '2023-06-12T16:00:00.000Z'
author:
  - github:alejandroRbit
  - github:ChemaESP
  - name: keiht-cy
    url: https://github.com/keith-cy
    platform: github

image

But the update of metadata should be held on until the feature is ready. Or the object will be rendered into plain text({"name":"keiht-cy","url":"https://github.com/keithc-y","platform":"github"}) rather than structural data.