moja-global / moja-global/FLINT-UI
Documentation: Update the README file with installtion commands
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Vue
- Stars
- 52
- Forks
- 86
- PR merge metrics
- No merged PRs in 30d
Description
What is the current documentation state?
Currently the new users need to navigate through development notes to get the installation guide.
Where is this stated?
No response
Why do you want to improve the statement?
No response
Proposed Statement
We can update these steps in the readme file where installation guide for docker setup is given
Additional context.
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README and compare its Docker installation guide with docs/DevelopmentGuide/DevelopmentNotes.rst at the Vue app section. Move the relevant installation steps into the README and verify that the documented Docker setup is complete and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100