Skip to content

Expand and improve Client docs #2602

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

Merged
merged 15 commits into from
Jul 28, 2025
Merged

Expand and improve Client docs #2602

merged 15 commits into from
Jul 28, 2025

Conversation

hanpaine
Copy link
Contributor

@hanpaine hanpaine commented Jul 23, 2025

What does it do?

  • adds documentation for client.files.upload as implemented in Upload New Media File client#92
  • extends and improves documentation for initialization and authentication slightly

** note this documentation was created with the help of Dosu :)

Why is it needed?

Documentation for media upload is currently missing from Strapi docs.

Related issue(s)/PR(s)

strapi/client#92

hanpaine added 4 commits July 23, 2025 11:35
Clearer examples and addition of error message if baseURL is missing protocol
Added note that this is the only auth method currently; added error message
Standardising with rest of docs
@strapi-cla
Copy link

strapi-cla commented Jul 23, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ pwizla
❌ hanpaine
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

vercel bot commented Jul 23, 2025

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

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 24, 2025 1:54pm

@hanpaine hanpaine added this to the 6.6.5 milestone Jul 23, 2025
Copy link
Collaborator

@innerdvations innerdvations left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this your first Strapi PR?! 🎉

I gave it a quick look but haven't tested the code examples yet

@pwizla pwizla force-pushed the cms/client-doc-improvements branch from ac6cd23 to edd788d Compare July 23, 2025 13:25
This reverts commit edd788d.
@pwizla
Copy link
Collaborator

pwizla commented Jul 23, 2025

Hey @hanpaine!

Congrats on your very first docs PR! It's already great 🫶
I did a light review and added some comments.

However, upon further inspection 👀 , it seems I need to do a deeper rewrite. Because what's new is actually adding the upload method, but all the other ones are still valid (find, findOne, update, delete), right?

So I will largely reorganize the content, for consistency and clarity. Thank you very much again for your base work, it's really helpful! 👏
And then I'll ping devs for a tech review 👀

so that the new upload-related information better fits with the
existing information architecture
@pwizla
Copy link
Collaborator

pwizla commented Jul 23, 2025

@hanpaine I finished rewriting the PR content so it better fits with the existing information architecture.
@innerdvations and @jhoward1994 , feel free to review the technical accuracy 👀 🙏

(The only thing that's bugging me is that it's using "ids" in code examples. I thought we switched to documentId in Strapi 5. Unless this does not apply to the Media Library or Client? 🤔)

@pwizla pwizla self-assigned this Jul 23, 2025
@pwizla pwizla added the pr: updated content PRs updating existing documentation content label Jul 23, 2025
hanpaine and others added 2 commits July 24, 2025 13:24
Co-authored-by: Jamie Howard <48524071+jhoward1994@users.noreply.github.com>
Co-authored-by: Jamie Howard <48524071+jhoward1994@users.noreply.github.com>
U&P is usable now (but still not documented here)
@hanpaine hanpaine merged commit dd07583 into main Jul 28, 2025
3 of 4 checks passed
@hanpaine hanpaine deleted the cms/client-doc-improvements branch July 28, 2025 09:58
Copy link

👋 Thanks for contributing to Strapi's documentation!

I've reviewed the changes in your file, and here's what I found:

🎉 Excellent work! Your documentation perfectly follows all our writing guidelines.

What this means:
✅ Professional, clear tone throughout
✅ Well-structured content that's easy to follow
✅ Inclusive language that welcomes all readers

Your contribution is ready to help developers worldwide! 🌍

📚 Helpful Resources:
📖 Strapi's 12 Rules of Technical Writing
🎨 Documentation Style Guide


🤖 This review focuses only on the lines you've changed. Questions? Feel free to ask in the comments!

🔧 Manually triggered validation for PR #2602

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: updated content PRs updating existing documentation content source: CMS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants