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

Add guidelines on how to contribute a case study to the BDG #978

Closed
mouxdesign opened this issue Jan 24, 2023 · 5 comments · Fixed by #1022
Closed

Add guidelines on how to contribute a case study to the BDG #978

mouxdesign opened this issue Jan 24, 2023 · 5 comments · Fixed by #1022
Assignees
Labels
Copy Task is about improving text. Documentation Improvements or additions to documentation
Milestone

Comments

@mouxdesign
Copy link
Collaborator

Content request

Add in a content about how to contribute a case study to the BDG

Contribute to guide
Content guidelines
I've added in two pages here where this content could possibly go. At this stage totally open to where the content would ideally fit in.

Why would you like to change the content?
We are looking to build out the case study section of the BDG and so having a resource which people can use to easily and quickly create a case study would be useful to have.

Created a document on how to contribute a case study to the bitcoin design guide.
BDG Case Study Guidelines

To do Mo
Create a question document and link it to the bottom of this Google doc which was a good suggestion from Stephen so that next to this guideline doc people can quickly answer those questions and create a draft of a case study.

@GBKS GBKS added Documentation Improvements or additions to documentation Copy Task is about improving text. labels Jan 25, 2023
@mouxdesign
Copy link
Collaborator Author

@sbddesign Suggested creating a question document which could accompany the guidelines document. Linked below is a document with a list of questions which can then be used to create the case study.

It could be a google document that someone could make a copy of and edit to form a case study around the project they worked on.

Case Study Questions

@mouxdesign
Copy link
Collaborator Author

@pavlenex Thanks for offering to take a look. Link to google doc.

@pavlenex
Copy link
Contributor

Concept ACK. I like how you're helping people structure their case-study by answering questions. I think @ConorOkus has mentioned that that's what they did with LDK Case-studies, send questionnaire to people to answer and then structure it accordingly.

@mouxdesign
Copy link
Collaborator Author

mouxdesign commented Jun 21, 2023

Reviewed this content and made some changes to the content based on suggestions based on the comments on the google doc. Would appreciate another review just to check for if it reads well of if there are any bit we missed.

@mouxdesign
Copy link
Collaborator Author

Figma file linking to images

@GBKS GBKS linked a pull request Jul 6, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Copy Task is about improving text. Documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

3 participants