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

✨ Enhancement: Create the use cases page #426

Closed
Tracked by #158
benjagm opened this issue Mar 3, 2024 · 18 comments
Closed
Tracked by #158

✨ Enhancement: Create the use cases page #426

benjagm opened this issue Mar 3, 2024 · 18 comments
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Mar 3, 2024

Is your feature request related to a problem? Please describe

This is a new feature.

Describe the solution you'd like

As per the documentation strategy #strategy, we'd like to publish a use cases page. This page will be totally data driven, reading the information from a json file in the data folder.

I am thinking in a page similar to this one: https://nuclia.com/ai-search-use-cases/

Screenshot 2024-03-03 at 16 21 37

There will be a title and welcome message and later cards with the details of the use case.

The json storing the use cases will be based on:

  • Short title
  • Description supporting markdown

Please build the page with face use cases and as soon as the feature is ready I'll add the use cases.
Please build the page as per the branding and style of our page.

Similar issues: #421 #280

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

@benjagm benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Triage This is the initial status for an issue that requires triage. labels Mar 3, 2024
@DhairyaMajmudar
Copy link
Member

@benjagm I would like to work on this feature.

@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Mar 3, 2024
@VivekJaiswal18
Copy link
Contributor

Hey @benjagm I would want to work on this issue!

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

@VivekJaiswal18 please go ahead. Dhairya, please join me as reviewer of this PR.

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Mar 3, 2024
@DhairyaMajmudar
Copy link
Member

@VivekJaiswal18 please go ahead. Dhairya, please join me as reviewer of this PR.

Sure would be happy to do so :D

@VivekJaiswal18
Copy link
Contributor

@benjagm Thanks. :)

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

The link to this page will go under the overview section.

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 6, 2024

@DhairyaMajmudar
Copy link
Member

@VivekJaiswal18 if you need any help feel free to ask : )

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 11, 2024

@VivekJaiswal18 please proceed with the integration if the component Card available in the parent branch. If you need to modify the component let's discuss first because others are integrating it.

@VivekJaiswal18
Copy link
Contributor

Okay Benja, working on the integration

@VivekJaiswal18
Copy link
Contributor

Hey, @benjagm sorry for the delay due to some mid sem internal tests going on last week.
I want to take your suggestion on the design changes for the use cases page. Should I change it/make a new card component
Before:
image

After:
image
I have made some changes like - text size and some alignments.
Intention for the changes - For pages like these user should be able to see maximum information at the first glance without scrolling too much.
Here the heading and body text size was too big and taking extra space.
Please have a look and suggest what should I do.
Thank you for reading.

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

I like the result . Thanks!

@VivekJaiswal18
Copy link
Contributor

So shall I create a separate card component for the use cases page @benjagm

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

I don't think so. Instead modify the current card to use different sizes for the title depending on if there is icon or not. With icon size should be smaller, but without icon the title can be bigger.

Does this makes sense?

@VivekJaiswal18
Copy link
Contributor

VivekJaiswal18 commented Mar 21, 2024

Okay I will modify the same card component.
But I think size should be independent of whether icon is present or not as in use cases not many cards can have a icons that fits the use cases then in that case heading must not be bigger. This way the components will be flexible for any use.
This is just a suggestion I'll accept your final call on this.
Thank you

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

Let's add a new optional param called size or something like that. You can use it to overwrite te size. You can use M (your size) or XL (current)

Ore something else, but let's improve this card instead of duplicate it.

@VivekJaiswal18
Copy link
Contributor

Okay benja thanks for helping I will modify the existing component so that it is flexible with any heading size.

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

Closed as completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

No branches or pull requests

3 participants