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

chore: format docs #8629

Merged
merged 1 commit into from Jul 5, 2022
Merged

chore: format docs #8629

merged 1 commit into from Jul 5, 2022

Conversation

jrandolf
Copy link
Contributor

@jrandolf jrandolf commented Jul 5, 2022

This PR reenables formatting due to the code samples.

@jrandolf jrandolf requested a review from OrKoN July 5, 2022 13:32
@jrandolf jrandolf merged commit b5a345b into main Jul 5, 2022
@jrandolf jrandolf deleted the test3 branch July 5, 2022 13:41
abozhilov pushed a commit to abozhilov/puppeteer that referenced this pull request Jul 5, 2022
@ushuz
Copy link

ushuz commented Jul 6, 2022

Sorry to disturb, is there a way to see docs for older version? Searching on the new docs site is quite frustrating.

@OrKoN
Copy link
Collaborator

OrKoN commented Jul 6, 2022

@ushuz Hey, thanks for the feedback? Do you have anything specific we can improve on the new site? You can see docs for the older version on GitHub, e.g., https://github.com/puppeteer/puppeteer/blob/v14.2.0/docs/api.md

@ushuz
Copy link

ushuz commented Jul 6, 2022

Update (July 21, 2022): Old docs are still available at: https://puppeteer.github.io/pptr.dev/#?version=v15.2.0


@OrKoN Thanks for the quick response. I'm using Chinese translation site that offers both previous versions and old search as a workaround.


For example, search reload:

Old search (Chinese translation site still uses the old layout and search in case anyone else is looking for it):
image

New search:
image


Also, the new search may sent visitors to a weird xxx_1 page that only shows method signature, instead of documentation, for example, clicking waitForSelector result ...

image

... brings me to https://pptr.dev/api/puppeteer.page.waitforselector_1 (signature only) ...

image

... instead of https://pptr.dev/api/puppeteer.page.waitforselector (the one-page doc I was looking for)

image


Appreciate the effort to improve docs, but have to say that the new doc site is not as easy-to-use as the old one.

@OrKoN
Copy link
Collaborator

OrKoN commented Jul 6, 2022

@ushuz thanks for the feedback! The extra pages should be removed from the site as it was caused by multiple type signatures for the method which will be removed. We will keep improving the docs further!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants