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.

Sign up for GitHub

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

Jump to bottom

Comprehensive Review and Update of Project Documentation #35

Open
petermsouzajr opened this issue Dec 22, 2023 · 10 comments
Open

Comprehensive Review and Update of Project Documentation #35

petermsouzajr opened this issue Dec 22, 2023 · 10 comments
Assignees
@petermsouzajr
Labels
beginner Less project context required, involves less complex coding READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue

Comments

@petermsouzajr
Copy link
Owner

Issue Summary

The goal of this issue is to thoroughly review our project's documentation to verify its accuracy and clarity. We aim to ensure that new users or contributors can easily set up and understand the project using our existing documentation.

Objective

  • Conduct a full review of the project's documentation, following the setup and usage instructions as a new user would.
  • Identify any inaccuracies, outdated information, or unclear instructions.
  • Update the documentation to address these issues, improving clarity and accuracy.

Details and Implementation Guidance

  • Go through the project's setup process step-by-step, strictly following the documentation.
  • Note any discrepancies between the documentation and the actual setup process, including missing steps, outdated information, or unclear instructions.
  • Pay special attention to parts of the documentation that might be confusing for someone new to the project.
  • Make the necessary updates to the documentation, ensuring that it is comprehensive, clear, and up-to-date.
  • If you find any areas that could benefit from additional context or explanations, consider enhancing the documentation with more detailed descriptions or examples.
  • After making updates, re-test the documentation to ensure that a new user can successfully set up and use the project without external help.

Contribution Instructions

  • Fork the repository and create a feature branch for this issue.
  • As you go through the documentation, make notes of any issues you encounter.
  • Update the documentation in your branch, addressing all identified issues.
  • Ensure that any changes or additions maintain consistency with the project's documentation style and format.
  • Submit a pull request with your changes, clearly outlining the problems you encountered and how your updates address them.
  • Link your pull request to this issue for review and discussion.

Additional Notes

This issue is crucial for maintaining the usability and accessibility of our project, especially for new users and contributors. Accurate and clear documentation is key to the growth and success of open-source projects. We encourage contributors to approach this task with a fresh perspective, as if encountering the project for the first time, to ensure that our documentation is as helpful and user-friendly as possible.
@petermsouzajr petermsouzajr added the beginner Less project context required, involves less complex coding label Dec 22, 2023
@petermsouzajr petermsouzajr added READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue ready and removed ready labels Jan 29, 2024
@kavyashree-harsha
Copy link

Hi @petermsouzajr , I tried these steps:

  1. Installed qa-shadow-report using npm.
  2. Ran "qasr-setup", which should guide me through setting up framework for testing framework, I am getting below error, please find the screenshots below. I have also added my package.json file for your reference.
qasr_setup_error package json

@kavyashree-harsha
Copy link

I would like to contribute regarding some changes in the documentation part. I have created a fork, and started to test it in my playwright work setup. Going forward I keep posting issues i found.

@petermsouzajr
Copy link
Owner Author

petermsouzajr commented Oct 12, 2024 via email

@kavyashree-harsha
Copy link

thank you! it looks like i left out a detail, the instructions should be:: "Upon installing qa-shadow-report, you can run the command '[npx or yarn] qasr-setup' which... " or some other variant depending on how people installed the package, which packager they are using.

Hi Peter, with "npx qasr-setup" it is still not working. Says "Error: Could not find the Project root directory".
image

@petermsouzajr
Copy link
Owner Author

petermsouzajr commented Oct 12, 2024 via email

@kavyashree-harsha
Copy link

thank you so much for testing and checking it out, this is bad news! would you like to take a look into the Project Root Logic, or is it ok if i take a look?

I can try to take a look, my skills are mostly with automated testing tools. I am opening an issue on the same. You can check from your end. We can close it when ever it is ready to be closed.

@petermsouzajr
Copy link
Owner Author

petermsouzajr commented Oct 12, 2024 via email

@github-actions GitHub Actions
Copy link

Thanks for taking this issue! Let us know if you have any questions!

@kavyashree-harsha
Copy link

i see the bug filed on the issue page, nice work. is this on a Windows operating system? if you would liek to claim the issue, you can leave a comment on the issue with the text '.take' and it will add you as the issue owner

Hi @petermsouzajr , yes it is on Windows OS.

@github-actions GitHub Actions
Copy link

The issue you are trying to assign to yourself is already assigned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@petermsouzajr petermsouzajr

Labels
beginner Less project context required, involves less complex coding READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@petermsouzajr @kavyashree-harsha