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

docs: make it easier to launch the project #2326

Closed
4 tasks done
EstebanBAR0N opened this issue Nov 21, 2023 · 3 comments
Closed
4 tasks done

docs: make it easier to launch the project #2326

EstebanBAR0N opened this issue Nov 21, 2023 · 3 comments
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly 🟨 priority: medium Not blocking but should be fixed soon 🙅 status: discontinued Not suitable for work as repo is in maintenance

Comments

@EstebanBAR0N
Copy link

what's wrong with the documentation?

The aim is to make it easier to launch the project by updating the README.md file with a "Run project locally" section.

Add screenshots

Here is an overview of the documentation updated with this new section:

Screenshot 2023-11-21 at 15 42 56

Record
@EstebanBAR0N EstebanBAR0N added good first issue New-contributor friendly ✨ goal: improvement Improvement to an existing feature 📄 aspect: text Concerns the textual material in the repository 🚦status: awaiting triage Has not been triaged & therefore, not ready for work 🟨 priority: medium Not blocking but should be fixed soon labels Nov 21, 2023
@github-actions GitHub Actions
Copy link

To reduce notifications, issues are locked. Your issue will be unlock when we will add label as 🏁 status: ready for dev. Check out the contributing guide for more information.

@github-actions github-actions bot locked and limited conversation to collaborators Nov 21, 2023
@EstebanBAR0N EstebanBAR0N mentioned this issue Nov 21, 2023
Closed
@priyankarpal priyankarpal added 🙅 status: discontinued Not suitable for work as repo is in maintenance and removed 🚦status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 21, 2023
Repository owner unlocked this conversation Nov 21, 2023
@priyankarpal
Copy link
Owner

already mentioned in https://github.com/priyankarpal/ProjectsHut/blob/main/contributing.md

@priyankarpal priyankarpal closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2023
@EstebanBAR0N
Copy link
Author

@priyankarpal I think you've misunderstood what I'm proposing. I'm just proposing documentation to simplify how to launch the project locally. It's not about helping to add a new project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly 🟨 priority: medium Not blocking but should be fixed soon 🙅 status: discontinued Not suitable for work as repo is in maintenance
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@priyankarpal @EstebanBAR0N