seleniumhq.github.io icon indicating copy to clipboard operation
seleniumhq.github.io copied to clipboard

[🚀 Feature]: Guidelines for creating code samples

Open harsha509 opened this issue 8 months ago • 2 comments

Feature and motivation

  1. Ensure that all code samples use https://www.selenium.dev/selenium/web for testing, and include this requirement in the contributing guidelines.
  2. Decide whether assertions should be displayed in the documentation.
  3. If multiple lines need to be rendered within a single code block, enable the appropriate lines for display using the available printing from this reference.

harsha509 avatar Mar 26 '25 14:03 harsha509

@harsha509, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

github-actions[bot] avatar Mar 26 '25 14:03 github-actions[bot]

@harsha509 - i think this page needs to be updated -https://www.selenium.dev/documentation/about/contributing/ -- another section or more steps. i think we can elaborate on add example part and provide more information on this page. any suggestions?

rpallavisharma avatar Jul 25 '25 12:07 rpallavisharma