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

Move undici global methods out of Agent docs #610

Closed
ronag opened this issue Mar 23, 2021 · 4 comments
Closed

Move undici global methods out of Agent docs #610

ronag opened this issue Mar 23, 2021 · 4 comments
Assignees
@Ethan-Arrowood
Labels
Docs Changes related to the documentation good first issue Good for newcomers

Comments

@ronag
Copy link
Member

ronag commented Mar 23, 2021 •
edited
Loading

They don't really have anything to do with Agent per say and it would be nice if this is the page that most users start with and don't have to worry about the other details.

i.e. a page with:

# undici.request
# undici.stream
# undici.pipeline
# undici.upgrade
# undici.connect

is the only thing I think 90% of users need. Maybe should be the index page?
@ronag ronag added the Docs Changes related to the documentation label Mar 23, 2021
@mcollina
Copy link
Member

I agree.

@Ethan-Arrowood
Copy link
Collaborator

Ethan-Arrowood commented Mar 23, 2021 •
edited
Loading

Good idea!

I'll be making more contributions soon; I've been super busy with a workshop I'm hosting today.

@ShogunPanda
Copy link
Contributor

I can confirm it was mess for me to follow docs when starting using undici.

@mcollina mcollina added the good first issue Good for newcomers label Mar 25, 2021
@ronag ronag mentioned this issue Mar 29, 2021
Merged
@Ethan-Arrowood
Copy link
Collaborator

I noticed these got added to the main readme - closing this issue now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Ethan-Arrowood Ethan-Arrowood

Labels
Docs Changes related to the documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@mcollina @ShogunPanda @ronag @Ethan-Arrowood