bluesky-social / bsky-docs

Bluesky API documentation
https://docs.bsky.app
Other
82 stars 71 forks source link

Missing Showcase submission instructions #122

Open juni-b-queer opened 5 months ago

juni-b-queer commented 5 months ago

When I went to the showcase page and clicked the "Submit your project here" there were no instructions or best practices to follow. I went through previous PRs that added items to the showcase and figured it so I just submitted my first showcase project #121!

I'm not saying it needs a detailed walk through, but any mention of submissions in the Readme would be nice if that's where the submission link directs to. Questions that would be helpful to know

This added documentation could be as simple as

Submitting to the Community Showcase

  1. Fork the bsky-docs repo
  2. In src/data/users.tsx, add your submission with {include required info}
  3. (Optional) Add photo to src/data/showcase/ {include image requirements/limitations}
  4. Commit changes to a branch in your fork
  5. Make a PR to merge your branch into the main bsky-docs {include what's needed in the PR}
  6. Done! (?)

I'm also more than happy to make a PR to add this, but I don't have the answers to all of the questions right now.

Sanhajio commented 5 months ago

Fork the project and submit a PR, I had the same question, I git diff <commit_hash> to know how projects are added, but having a process would have helped

lamrongol commented 3 months ago

I agree with this, I especially want to know the details. Edited: I noticed User elements and tags list exist on users.tsx