search

pieces-app / documentation

Official documentation for Pieces for Developers
https://docs.pieces.app
402 stars 50 forks source link

docs: update FAQ section #294

Closed CBID2 closed 7 months ago

CBID2 commented 8 months ago

Description

This PR updates the FAQ section.

Related Tickets and Documents

Closes #256

Notes to Reviewers

This is still a work in progress

vercel[bot] commented 8 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Mar 22, 2024 1:45am
CBID2 commented 8 months ago

Hey @mason-at-pieces. Even though this is still a work-in-progress, there are some parts I need help with, so I added them as comments in my pull request. Check them out.

mason-at-pieces commented 8 months ago

@CBID2 Let me know if you need any help on this update. We want to keep things moving so we can get this in by the end of the month 👍

CBID2 commented 8 months ago

@CBID2 Let me know if you need any help on this update. We want to keep things moving so we can get this in by the end of the month 👍

Sure @mason-at-pieces. I'm going to make some updates today

CBID2 commented 8 months ago

Hey @mason-at-pieces. I got the content in for the Pieces OS section in the FAQs, I was unable to download the screenshots @rosie-at-pieces posted in the google doc, so can you add them in there please?

mason-at-pieces commented 8 months ago

Hey @mason-at-pieces. I got the content in for the Pieces OS section in the FAQs

So there isn't a Pieces OS section, instead that is part of the How do I check my Pieces versions and update the app? question. Do you see how we have it structured on the doc?

CBID2 commented 8 months ago

Hey @mason-at-pieces. I got the content in for the Pieces OS section in the FAQs

So there isn't a Pieces OS section, instead that is part of the How do I check my Pieces versions and update the app? question. Do you see how we have it structured on the doc?

Hey @mason-at-pieces. So should I retitle Pieces OSto How do I check my Pieces versions and update the app?? I couldn't find that section in the current version of the FAQ.

rosie-at-pieces commented 8 months ago

@CBID2 just to clarify, are you using this document:

https://docs.google.com/document/d/1NFi5khaElnkpOBNwoApiGNtxYjylQ0lZrYNZKTVEJBA/edit?usp=sharing

CBID2 commented 8 months ago

@CBID2 just to clarify, are you using this document:

https://docs.google.com/document/d/1NFi5khaElnkpOBNwoApiGNtxYjylQ0lZrYNZKTVEJBA/edit?usp=sharing

Yes @rosie-at-pieces.

rosie-at-pieces commented 8 months ago

ok great - so you should be able to open up the outline of the document which should help drive your structure.

for the one in question above, the section is How do I check my Pieces versions and update the app? and there are several sections underneath - Pieces Desktop App, PiecesOS, Pieces VS Code...etc. And under PiecesOS there are three sections - Mac, Windows, and Linux.

so there's a good bit of structure here that we need to think on. the desktop app, vs code, etc are all agnostic to the OS so they don't really fit under mac, linux, windows @mason-at-pieces

CBID2 commented 7 months ago

Hi @mason-at-pieces. I made the adjustments you and @rosie-at-pieces suggested for the first part(I also added the sections for the Pieces extensions I hope you don't mind 😄 ). Now, I can't download the screenshots in the google doc Rosie presented, so I'm going to need your help with this part.

mason-at-pieces commented 7 months ago

Hey @CBID2, so we actually had to make some adjustments on our end and this resulted in us just completing this internally.

We are still figuring out the best way to have contributors on our docs so I appreciate your patience in this process!

My idea is that we have issues that we will complete internally but also ensure that we have issues open for contributors to work on. Would love your feedback on this idea as well if you'd like to open a discussion to chat about: https://github.com/pieces-app/opensource/discussions 👍

For now, I will close this pr and we can work on getting a better process in place to ensure we don't have more prs like this that we have to close for some reason that is our fault 👍

CBID2 commented 7 months ago

Hey @CBID2, so we actually had to make some adjustments on our end and this resulted in us just completing this internally.

We are still figuring out the best way to have contributors on our docs so I appreciate your patience in this process!

My idea is that we have issues that we will complete internally but also ensure that we have issues open for contributors to work on. Would love your feedback on this idea as well if you'd like to open a discussion to chat about: https://github.com/pieces-app/opensource/discussions 👍

For now, I will close this pr and we can work on getting a better process in place to ensure we don't have more prs like this that we have to close for some reason that is our fault 👍

Hey @mason-at-pieces. I took your advice and created a discussion. Here it is: https://github.com/pieces-app/opensource/discussions/65#discussion-6427347