Skip to content

Adding ComponentsV2 page (Popular Topics) #1620

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

PakjeBecel
Copy link

  • Added new page under "Popular Topics" section called "Components V2"

Since I have an issue with running the guide in a local environment, I cannot run the guide locally. Someone else has to check first if this PR will render properly when merged.

@Amgelo563
Copy link
Contributor

I'm not sure whether we should call sections and text display "top level" components since they can also be used as a child inside a container, so it's half true, waiting for opinions.

@PakjeBecel
Copy link
Author

PakjeBecel commented May 4, 2025

@Amgelo563 Discord released the restrictions of top-level components, so maybe it isn't even worth mentioning whether a component is top-level or not anymore -- wrote those parts when the restriction still existed.

@Jiralite Jiralite added type: enhancement t: page/section addition Pull Request to add new content to the guide labels May 4, 2025
Copy link
Member

@Jiralite Jiralite left a comment

Choose a reason for hiding this comment

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

Could you place this file appropriately in guide/.vuepress/sidebar.ts? This will make it appear in the sidebar.

Looks like you have to run linting on your changes too.

@PakjeBecel PakjeBecel marked this pull request as ready for review May 4, 2025 22:55
Copy link
Member

@monbrey monbrey left a comment

Choose a reason for hiding this comment

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

Hope I'm not coming across too harsh in my review - I really like the overall structure and the way the examples are presented.

My main concern is just the phrasing of CV2 as "new" and being a little overly comparative - they're only new now, but won't be forever. Write the guide as if they've always existed.

…ail" section for better readability from top to bottom
Copy link
Contributor

@Amgelo563 Amgelo563 left a comment

Choose a reason for hiding this comment

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

I'd argue that yes, they are utilities and it's useful to show them as such so the user doesn't think they're required, but they are not mentioned as such on any other page. So for consistency sake the "utility" mentions should be removed.

});
```

![Text display component preview](./images/cv2-textdisplay-preivew.png)
Copy link
Member

Choose a reason for hiding this comment

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

Renaming the file to textdisplay-preview.png would be the better fix instead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t: page/section addition Pull Request to add new content to the guide type: enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants