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

[📑 Docs]: Lets create a welcome page for the docs section #421

Closed
1 task done
Tracked by #158
benjagm opened this issue Mar 3, 2024 · 13 comments
Closed
1 task done
Tracked by #158

[📑 Docs]: Lets create a welcome page for the docs section #421

benjagm opened this issue Mar 3, 2024 · 13 comments
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Mar 3, 2024

What Docs changes are you proposing?

Inspired by the good work of AsyncAPI Team, we think it would be great to create a welcome page to our docs section with a welcome message and a card for each subsection of our docs:

  • Overview
  • Getting started
  • Reference
  • Specification

This will also required add a new section on top of the sidebar called Welcome. We'll need to make this totally consisten with the style of our website.

See images for inspiration:
Screenshot 2024-03-03 at 15 16 34

Code of Conduct

  • I agree to follow this project's Code of Conduct
@benjagm benjagm added 📝 Documentation Indicates improvements or additions to documentation. Status: Available No one has claimed responsibility for resolving this issue. labels Mar 3, 2024
@github-actions github-actions bot added the Status: Triage This is the initial status for an issue that requires triage. label Mar 3, 2024
@TamannaVerma99
Copy link
Contributor

Hey @benjagm !
Is this issue available for taking up?
If yes, I would love to contribute towards it :)

@benjagm benjagm removed the Status: Triage This is the initial status for an issue that requires triage. label Mar 3, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

Yes. This is available. Please go ahead.

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

benjagm commented Mar 3, 2024

The screenshot is just for inspiration. Please use styles according to our website and branding.

@officeneerajsaini
Copy link
Contributor

I am also excited to work on this issue. Maybe I know you assigned it to someone, but can I work on this too? @benjagm

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 3, 2024

@officeneerajsaini are you open to work on #280 ? It is similar to this one.

@TamannaVerma99
Copy link
Contributor

The screenshot is just for inspiration. Please use styles according to our website and branding.
Sure! I will take care of that.

@officeneerajsaini
Copy link
Contributor

@officeneerajsaini are you open to work on #280 ? It is similar to this one.

Okay ,

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 11, 2024

@TamannaVerma99 are you still working on this?

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 11, 2024

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

@lalitkumawat1m
Copy link
Contributor

Hey @TamannaVerma99!
Are you working on this issue or can I take this?

@TamannaVerma99
Copy link
Contributor

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

Working on it @benjagm sorry for the delay ,actually I was working on casestudies page since it was also blocked due to card component.

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

This is now in the release 3 branch pending to be merged into main.

@benjagm benjagm closed this as completed Apr 11, 2024
@benjagm benjagm mentioned this issue Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

No branches or pull requests

4 participants