docs: add initial examples by Barbapapazes · Pull Request #288 · unjs/ofetch · GitHub
Skip to content

docs: add initial examples#288

Merged
pi0 merged 12 commits into
mainfrom
docs/examples
Oct 26, 2023
Merged

docs: add initial examples#288
pi0 merged 12 commits into
mainfrom
docs/examples

Conversation

@Barbapapazes

@Barbapapazes Barbapapazes commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR will add examples for an upcoming 101 article about ofetch (unjs/website#108). In order to use the last version of ofetch, I create pnpm workspace.

I order to avoid regression in articles, I think we could add an action to check types of examples!

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Sep 4, 2023
@Barbapapazes Barbapapazes self-assigned this Sep 4, 2023
@codecov

codecov Bot commented Sep 4, 2023

Copy link
Copy Markdown

@Barbapapazes Barbapapazes requested a review from pi0 September 5, 2023 16:08
@Barbapapazes Barbapapazes marked this pull request as ready for review September 5, 2023 16:13
Comment thread examples/README.md Outdated

In this directory you can find some examples of how to use ofetch.

To learn more, you can read the [ofetch first hand tutorial on unjs.io](https://unjs.io/resources/learn/ofetch-101-firs-hand).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
To learn more, you can read the [ofetch first hand tutorial on unjs.io](https://unjs.io/resources/learn/ofetch-101-firs-hand).
To learn more, you can read the [ofetch first hand tutorial on unjs.io](https://unjs.io/resources/learn/ofetch-101-first-hand).

@pi0 pi0 changed the title docs: add examples docs: add initial examples Oct 26, 2023
@pi0

pi0 commented Oct 26, 2023

Copy link
Copy Markdown
Member

@pi0 pi0 merged commit da64d78 into main Oct 26, 2023
@pi0 pi0 deleted the docs/examples branch October 26, 2023 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants