[Docs]: Add more info about environment IDs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 91
- PR merge metrics
- No merged PRs in 30d
Description
what's wrong with the documentation?
Users do not know about environment ID and what's it used for. They are confused as to when new environments are created or updated, because it depends on the environment ID, which in turn is either specified explicitly or calculated based on the branch name and project directory.
Add a section in the doc detailing this with references from the up command doc and intro.
Add screenshots
none
Record
- I agree to follow this project's Code of Conduct
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
Read the existing up command documentation and project intro first to understand how environment IDs are specified or derived. Add a section explaining their purpose and when environments are created or updated, with references between those docs; done means the ID behavior is clear to users.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100