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

Update direct links to docs on Cucumber website #833

Open
mlvandijk opened this issue Jan 19, 2023 · 0 comments
Open

Update direct links to docs on Cucumber website #833

mlvandijk opened this issue Jan 19, 2023 · 0 comments
Labels
🐛 bug Defect / Bug

Comments

@mlvandijk
Copy link
Member

👓 What did you see?

Since adding the Cucumber docs to the SmartBear site, there is a menu option "Docs" that offers several links to the actual docs:

  • The arrow > goes to https://cucumber.io/docs/cucumber/ - which is a good place to start
  • Installation
  • Gherkin Syntax
  • API Docs -> goes to API automation tools that are not Cucumber
  • 3rd Party Tools -> goes to tools that for the most part are not cucumber.

I think nr 4 and 5 should not be part of this high level menu. We tried to fix this previously in #433 but this seems to have been reverted or overwritten.

✅ What did you expect to see?

Instead of links to API Docs and 3rd Party Tools, which are both not cucumber, we should provide direct links to relevant pages.
Possibly the API Docs intended to link to https://cucumber.io/docs/cucumber/ which would be more useful.

In addition, direct links to the 10 Minute Tutorial and Guides would help users find the information they need more quickly.

📦 Which tool/library version are you using?

N/A

🔬 How could we reproduce it?

Go to https://cucumber.io/ and click the Docs menu

📚 Any additional context?

As discussed in weekly committers meeting on Jan 19th 2023.

@mlvandijk mlvandijk added the 🐛 bug Defect / Bug label Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Defect / Bug
Projects
None yet
Development

No branches or pull requests

1 participant