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

Author displays incorrectly #29

Open
matt-nervos opened this issue Jun 14, 2023 · 15 comments
Open

Author displays incorrectly #29

matt-nervos opened this issue Jun 14, 2023 · 15 comments
Assignees

Comments

@matt-nervos
Copy link
Contributor

matt-nervos commented Jun 14, 2023

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
Copy link
Collaborator

Tracked by Magickbase/nervos-official-website#192

@Keith-CY Keith-CY self-assigned this Jun 14, 2023
@Keith-CY
Copy link
Collaborator

Keith-CY commented Jun 14, 2023

Fixed by cc29371

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

image
image

@matt-nervos
Copy link
Contributor Author

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
Copy link
Collaborator

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
Copy link
Contributor Author

@WhiteMinds just want to follow up on this one

@WhiteMinds
Copy link
Contributor

@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
Copy link
Contributor Author

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

@WhiteMinds
Copy link
Contributor

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
Copy link
Contributor Author

can we add a mouse over that displays the names?

@Keith-CY
Copy link
Collaborator

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
Copy link
Contributor Author

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

@Keith-CY
Copy link
Collaborator

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

Sure, we'll start this work

@Keith-CY
Copy link
Collaborator

Keith-CY commented Aug 6, 2023

@matt-nervos
Copy link
Contributor Author

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

@Keith-CY
Copy link
Collaborator

Keith-CY commented Aug 7, 2023

@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.

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

No branches or pull requests

3 participants