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

Fixed W3C WebDriver Spec links in API docs. #4166

Merged
merged 13 commits into from
May 27, 2024

Conversation

Halim-Shams
Copy link
Contributor

@Halim-Shams Halim-Shams commented Apr 3, 2024

@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:

  • Placed and moved all the W3C-related links to @link tag in JSDoc.
  • Placed and moved all other links to @see tag in JSDoc.
  • Fixed all the broken links.
  • Reduced the complete URLs to only /#abc-abc format.

Let me know if these changes are appropriate or if it needs some improvements.

@CLAassistant
Copy link

CLAassistant commented Apr 3, 2024

CLA assistant check
All committers have signed the CLA.

@Halim-Shams Halim-Shams changed the title Fixed all the W3C WebDriver spec broken links and categorized all the @link and @see links in API docs nightwatchjs/nightwatch-docs#293 Fixed all the W3C WebDriver spec broken links and categorized all the @link and @see links in API docs Apr 3, 2024
Copy link
Member

@garg3133 garg3133 left a 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.

lib/api/element-commands/clickAndHold.js Outdated Show resolved Hide resolved
package-lock.json Outdated Show resolved Hide resolved
@Halim-Shams Halim-Shams changed the title nightwatchjs/nightwatch-docs#293 Fixed all the W3C WebDriver spec broken links and categorized all the @link and @see links in API docs Fixed all the W3C WebDriver spec broken links and categorized all the @link and @see links in API docs Apr 3, 2024
@garg3133
Copy link
Member

@Halim-Shams Like I mentioned before, package-lock.json file shouldn't be a part of this PR. To do that, directly deleting the file won't help because the PR now shows that the file should be deleted from the repository itself, which isn't what we want.

Instead, what you can do is copy the package-lock.json file from the original repository and save it in your local project, commit it and then push it to this branch. That should remove the changes related to the package-lock.json file from this PR.

@ParmarKrishna
Copy link

I think, what @garg3133 is trying to convey is, package-lock.json shouldn't be listed as one of the files that has changes in the "File Changed" section of your commit.

@Halim-Shams
Copy link
Contributor Author

@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.

Copy link
Member

@garg3133 garg3133 left a 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.

lib/api/client-commands/document/source.js Outdated Show resolved Hide resolved
lib/api/element-commands/clickAndHold.js Show resolved Hide resolved
lib/api/web-element/commands/sendKeys.js Show resolved Hide resolved
@Halim-Shams
Copy link
Contributor Author

@garg3133 The suggestions were modified, and it worked successfully by running the nightwatch repo inside the nightwatch-docs repository.

If you see any issue do let me know.

Copy link

Status

  • ❌ No modified files found in the types directory.
    Please make sure to include types for any changes you have made. Thank you!.

Copy link
Member

@garg3133 garg3133 left a 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.

@garg3133 garg3133 changed the title Fixed all the W3C WebDriver spec broken links and categorized all the @link and @see links in API docs Fixed W3C WebDriver Spec links in API docs. May 27, 2024
@garg3133 garg3133 merged commit 88c9acd into nightwatchjs:main May 27, 2024
16 of 17 checks passed
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

4 participants