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

docs: add initial examples #288

Merged
merged 12 commits into from
Oct 26, 2023
Merged

docs: add initial examples #288

merged 12 commits into from
Oct 26, 2023

Conversation

Barbapapazes
Copy link
Member

@Barbapapazes Barbapapazes commented Sep 4, 2023

πŸ”— 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
Copy link

codecov bot commented Sep 4, 2023

Codecov Report

Merging #288 (0eb629b) into main (3482a56) will not change coverage.
The diff coverage is n/a.

❗ Current head 0eb629b differs from pull request most recent head 3dd4afe. Consider uploading reports for the commit 3dd4afe to get more accurate results

@@           Coverage Diff           @@
##             main     #288   +/-   ##
=======================================
  Coverage   92.00%   92.00%           
=======================================
  Files           5        5           
  Lines         450      450           
  Branches      102      102           
=======================================
  Hits          414      414           
  Misses         36       36           

@Barbapapazes Barbapapazes marked this pull request as ready for review September 5, 2023 16:13

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
Member 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
Copy link
Member

pi0 commented Oct 26, 2023

Thanks for working on this and sorry got delayed to review. I have made a couple of reactors in order to keep changes minimal allowing to iterate over examples idea (once the article is ready, we can see what else is needed to make them running easier for users, i am thinking of some tooling...)

@pi0 pi0 merged commit da64d78 into main Oct 26, 2023
4 checks passed
@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