Comments (8)
I understood the issue here, and I am working on it.
from nightwatch-docs.
all the links related to W3C should be placed in the @link tag in JSDoc throughout the Nightwatch APIs (present in nightwatchjs/nightwatch repo), and all other links should be put in the @see tag.
Regarding this, there are two versions of @link
tag found in the files. For example, lib/api/client-commands/document/source.js has entire link (such as, @link https://www.w3.org/TR/webdriver#getting-page-source
) in the tag, where as other files such as, lib/api/client-commands/document/executeAsyncScript.js has only /#execute-async-script
in the tag.
Hence, should link tag contain only #references-page
or entire link as shown above?
Additionally, the URL is also incorrect.
from nightwatch-docs.
The @link
tag can contain links in /#execute-async-script
format only, no need to specify complete URLs.
There are also some pages where the @link
tag is incorrect (ex. the link present in element.clickAndHold page doesn't lead to anywhere), we'd need to fix those as well (or remove them if there's no such section and instead add a selenium doc reference).
Also, if there are some non-webdriver spec related links present in the @link
tag, we would need to move them to @see
tag. Similarly, if there are some webdriver spec related links present in @see
tag, we'd move them to @link
tag.
from nightwatch-docs.
okay. understood.
from nightwatch-docs.
hey @garg3133 is this issue also fixed??
from nightwatch-docs.
@Shubhdeep02 The second task of this issue is not completely fixed yet. A few links were fixed here though: nightwatchjs/nightwatch#4166.
from nightwatch-docs.
@garg I have been trying to figure out the Nightwatch APIs JSDoc but it seems to me that all the links related to W3C are already placed in the @link
tag or am i missing something?
from nightwatch-docs.
@Shubhdeep02 The issue here is that all the links related to W3C should be present under the @link
tag and the @link
tag should only contain the W3C links (usually starts with /#
in JSDoc) and no other links. There are a few places where some other link is present in the @link
tag, those should either be deleted (in case they are starting with /session
) or moved to the @see
tag.
Additionally, we need to ensure that all the W3C WebDriver spec links on the Nightwatch API docs website work and that they take you to the correct section on the target page (when going through the W3C links in the Nightwatch repository, just type the name of the file containing that link in the left navigation search bar of Nightwatch API docs and cross-check if the W3C link on the resultant page actually work).
The same thing needs to be done for the @see
tag -- they should either contain the plain command names (like cookies.accept
, session
, etc.) or HTTP links other than the W3C spec links. Additionally, need to ensure that those links actually work on the actual website.
from nightwatch-docs.
Related Issues (20)
- Google Season Of Docs HOT 1
- Typo on component-testing/introduction.html
- Update documentation for `assert.hasAttribute` HOT 1
- Documentation links are broken in v2.6.21 HOT 2
- Nightwatch Version 3 - Parallel Execution HOT 3
- Menu suspended HOT 2
- Add disable_output_boxes flag to the docs HOT 2
- Several minor improvements to the website and documentation HOT 4
- yml example is rendered Code but without line breaks -> white-space: pre; HOT 5
- UI Breaking when subscribing to newsletter. HOT 1
- Broken Links to Contributing Guidelines in Docs HOT 3
- Add documentation for new Element API HOT 1
- Fix nightwatchjs.org links across the website HOT 6
- MSEdge documentation out of date / has broken links
- Docs: Add a `alias` section in `Nightwatch.js` Docs for the new Element API.
- add info about globals HOT 1
- How to use --rerun-failed field
- How to use folder_format? HOT 2
- Fix Selenium API doc links. HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nightwatch-docs.