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

docs: split readme into subsection and document missing helpers #428

Merged
merged 1 commit into from
Jul 7, 2023
Merged

docs: split readme into subsection and document missing helpers #428

merged 1 commit into from
Jul 7, 2023

Conversation

Hebilicious
Copy link
Member

@Hebilicious Hebilicious commented Jul 6, 2023 •
edited
Loading

  • feat: add request and response helpers
  • feat: add url utilities
  • docs: document all builtins in readme

🔗 Linked issue

#420
#423

❓ 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

/!\ Careful this PR is against #427 , not main .

This update the readme to improve the readability and document the missing helpers.

📝 Checklist

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

@Hebilicious Hebilicious changed the base branch from main to missing-helpers-lean July 6, 2023 14:23
@Hebilicious Hebilicious changed the title refactor readme docs: split readme into subsection and document missing helpers Jul 6, 2023
@Hebilicious Hebilicious mentioned this pull request Jul 6, 2023
Closed
8 tasks
@Hebilicious Hebilicious added documentation Improvements or additions to documentation helpers labels Jul 6, 2023
@Hebilicious Hebilicious requested a review from pi0 July 6, 2023 15:28
@pi0 pi0 changed the base branch from missing-helpers-lean to main July 7, 2023 20:14
@pi0 pi0 force-pushed the refactor-readme branch from d59447b to 24ee7a3 Compare July 7, 2023 20:16
@pi0
Copy link
Member

pi0 commented Jul 7, 2023

Thanks! (I have rebased your changes to make it mergeable against main and iterate quickly)

@pi0 pi0 merged commit c50d296 into main Jul 7, 2023
@pi0 pi0 deleted the refactor-readme branch July 7, 2023 20:17
@pi0 pi0 mentioned this pull request Aug 4, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pi0 pi0 pi0 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation helpers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Hebilicious @pi0