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.

Sign up for GitHub

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

Jump to bottom

Feature: Add Dev Cards to Getting Started #156

Closed
2 tasks done
BekahHW opened this issue Sep 1, 2023 · 7 comments · Fixed by #158
Closed
2 tasks done

Feature: Add Dev Cards to Getting Started #156

BekahHW opened this issue Sep 1, 2023 · 7 comments · Fixed by #158
Assignees
@CBID2
Labels
chore label to mark dependency and documentation updates 💡 feature A label to note if work is a feature released

Comments

@BekahHW
Copy link
Member

BekahHW commented Sep 1, 2023

Type of feature

🍕 Feature

Current behavior

Currently, we don't have any documentation on Dev cards. We need to add a section.

Suggested solution

Let's highlight our Dev Card feature: https://insights.opensauced.pizza/user/bekahhw/card

For each section in the Getting Started category, we need to keep in mind the following:

  1. Features are for maintainers and contributors at all stages of their journey. Descriptions should be inclusive of that audience.
  2. The first part of the feature documentation should explain what the feature is and why it's useful.
  3. There should be a screenshot or gif that demonstrates what the feature is or what it does.
  4. If necessary, explain why it's important to contributors and maintainers.

Keeping that in mind, let's add Dev Card to the Getting Started panel.

How to Implement this issue

  1. In the repository, go to docs/community
  2. Add a file called dev-card.md
  3. In sidebar.js, add "community/dev-card", to the items array.
  4. In dev-card.md replicate the frontmatter in any of the other community files (frontmatter is the part container between the ---) but replace with devcard and update the description.
  5. Within that file, create the copy to using the guidelines above.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@BekahHW BekahHW added 💡 feature A label to note if work is a feature 👀 needs triage labels Sep 1, 2023
@CBID2
Copy link
Contributor

CBID2 commented Sep 1, 2023

This is a great idea @BekahHW! :) This feature could also be for the triage team members too. I'd like to work on this issue.

@BekahHW
Copy link
Member Author

BekahHW commented Sep 1, 2023

It's all you, @CBID2

@CBID2
Copy link
Contributor

CBID2 commented Sep 1, 2023

It's all you, @CBID2

Thanks @BekahHW! :)

@CBID2 CBID2 added the chore label to mark dependency and documentation updates label Sep 1, 2023
@Lymah123
Copy link
Contributor

Lymah123 commented Sep 2, 2023

Can I contribute?
I hope is beginner friendly.

@CBID2
Copy link
Contributor

CBID2 commented Sep 2, 2023

Can I contribute?

I hope is beginner friendly.

Hi @Lymah123. I've been assigned to this issue. However, I'm eager to receive your review on it once I get the PR
done.

@Lymah123
Copy link
Contributor

Lymah123 commented Sep 2, 2023

@CBID2 . Alright.

Looking forward to that. Thank you.

This was referenced Sep 3, 2023
Closed
Merged
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

🎉 This issue has been resolved in version 1.43.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CBID2 CBID2

Labels
chore label to mark dependency and documentation updates 💡 feature A label to note if work is a feature released
Projects
None yet
Milestone
No milestone
3 participants
@BekahHW @CBID2 @Lymah123