-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Fixed W3C WebDriver Spec links in API docs. #4166
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, thanks a lot!
Hope you've verified that all the links that are part of the @link
tag actually work.
@Halim-Shams Like I mentioned before, Instead, what you can do is copy the |
I think, what @garg3133 is trying to convey is, |
@garg3133 I've copied the code from the original repo's package-lock.json file and pasted it into my local package-lock.json file, and everything works the way expected. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could check if the changes you're making are taking effect on the actual website or not by setting up the nightwatch-docs
project locally and then setting API_DOCS_FOLDER
option in postdoc.config.js
to point to your Nightwatch repository.
Also, this PR does not fix "all" the links in the repository as the title claims, but fixing these many links is also fine for now.
@garg3133 The suggestions were modified, and it worked successfully by running the If you see any issue do let me know. |
Status
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now. I've fixed a few other W3C links and migrated them from the @see
tag to the @link
tag.
Thanks a lot for this PR.
Co-authored-by: Priyansh Garg <priyanshgarg30@gmail.com>
@garg3133 Review the requested changes for the issue of fixing the broken links and categorizing them. nightwatchjs/nightwatch-docs#293
I've reviewed all the Nightwatch APIs documentation and did the following:
@link
tag in JSDoc.@see
tag in JSDoc./#abc-abc
format.Let me know if these changes are appropriate or if it needs some improvements.