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.

Sign up for GitHub

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

Jump to bottom

content: create ofetch 101 article #108

Closed
wants to merge 15 commits into from
Closed

content: create ofetch 101 article #108

wants to merge 15 commits into from

Conversation

Barbapapazes
Copy link
Member

@Barbapapazes Barbapapazes commented Sep 4, 2023 •
edited

🔗 Linked issue

fix #111

❓ 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 create a new 101 article about ofetch.

  • finish article (correct typos)
  • add article layout (similar to blog-post that we could reuse)
  • create learn page (like blog or packages with search and more)
  • add links in footer
  • update header
  • create alert component for article

waiting for #158

related to unjs/ofetch#288

📝 Checklist

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

@Barbapapazes Barbapapazes added the content A change in the content folder label Sep 4, 2023
@Barbapapazes Barbapapazes self-assigned this Sep 4, 2023
@nuxt-studio
Copy link
Contributor

nuxt-studio bot commented Sep 4, 2023 •
edited

✅ Live Preview ready!

Name Edit Preview Latest Commit
unjs-website Edit on Studio ↗︎ View Live Preview 372e96c

@Barbapapazes Barbapapazes mentioned this pull request Sep 5, 2023
Merged
8 tasks
@pi0 pi0 self-requested a review September 5, 2023 16:40
@Barbapapazes Barbapapazes changed the title docs: create ofetch 101 article content: create ofetch 101 article Sep 5, 2023
@Atinux
Copy link
Member

Atinux commented Sep 6, 2023

Shall we also add examples about interceptors?

Question from https://www.reddit.com/r/Nuxt/comments/16bi7la/comment/jze9uz1/?context=3

@Barbapapazes
Copy link
Member Author

Shall we also add examples about interceptors?

Question from https://www.reddit.com/r/Nuxt/comments/16bi7la/comment/jze9uz1/?context=3

I deliberately did not talk about this feature to avoid to have a too long and complexe 101.

I didn't see 101 article to fully cover available API (more an introduction than a documentation). I see 101 as a good way to start both for newcomers and for people who want to discover the package and covering full API will makes article too heavy and less understandable !

But building a system like this is in a build article is a great idea which makes sens! And yes, explore and build article will be used to create real world things!

What do you think?

@Atinux
Copy link
Member

Atinux commented Sep 7, 2023

I guess it can be its own article for ofetch interceptors :)

@Barbapapazes Barbapapazes marked this pull request as ready for review September 8, 2023 13:26
@pi0
Copy link
Member

pi0 commented Mar 14, 2024

should go to official docs

@pi0 pi0 closed this Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pi0 pi0 Awaiting requested review from pi0

Assignees

@Barbapapazes Barbapapazes

Labels
content A change in the content folder
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ofetch 101
3 participants
@Barbapapazes @Atinux @pi0