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 Need Major Update #1228

Closed
leafoflegend opened this issue Jan 18, 2018 · 3 comments
Closed

Docs Need Major Update #1228

leafoflegend opened this issue Jan 18, 2018 · 3 comments
Labels
cat: documentation type: enhancement

Comments

@leafoflegend
Copy link

The docs for this repo include one Migration Doc, and one Graveyard doc. There is less then a page of explanation of how to use this library. This is an awesome library and deserves a thorough documentation revamp.
@shockey shockey mentioned this issue Apr 12, 2018
Closed
@dleistn1
Copy link

dleistn1 commented Jul 25, 2018 •
edited

Definitely + 1, I start using the lib a few days ago and ended up reading the source code to decrypt the possible options and the interfaces of the different properties (especially auth is a fu****g pain)

char0n added a commit that referenced this issue Apr 20, 2020
@char0n
docs: add full documentation for swagger spec resolver
e4bcc08 
Ref #729 #1228 #1409
@char0n char0n mentioned this issue Apr 20, 2020
Merged
10 tasks
@char0n
Copy link
Member

char0n commented Apr 20, 2020

Created first PR that should increase the documentation coverage and quality of our documentation. I've started with a Swagger specification resolver.

char0n added a commit that referenced this issue Apr 22, 2020
@char0n
docs(HTTP_Client): increase documentation coverage
e171ebe 
Ref #729 #1228 #1409
@char0n char0n mentioned this issue Apr 22, 2020
Merged
10 tasks
char0n added a commit that referenced this issue Apr 23, 2020
@char0n
docs(HTTPClient): increase documentation coverage (#1507)
45031b2 
Ref #729 #1228 #1409
char0n added a commit that referenced this issue Apr 23, 2020
@char0n
docs(TryItOut): increse documentation coverage
55b6b40 
Ref #729 #1228 #1409
char0n added a commit that referenced this issue Apr 24, 2020
@char0n
docs(TryItOut): increse documentation coverage
298ef34 
Ref #729 #1228 #1409
char0n added a commit that referenced this issue Apr 24, 2020
@char0n
docs(TryItOut): increse documentation coverage (#1509)
c06a685 
Ref #729 #1228 #1409
char0n added a commit that referenced this issue Apr 24, 2020
@char0n
docs: increase documentation coverage for swagger spec resolver (#1506)
27cc3bb 
Co-Authored-By: Ron <ron@swagger.io>

Ref #729 #1228 #1409
@char0n
Copy link
Member

char0n commented Apr 30, 2020

Documentation has been consolidated into docs/ directory.

@char0n char0n closed this as completed Apr 30, 2020
@hsingh23 hsingh23 mentioned this issue Jan 10, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cat: documentation type: enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@char0n @shockey @leafoflegend @dleistn1