redhat-developer / redhat-developer/vscode-yaml
Move documentation from the wiki to a documentation folder of the repo
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- TypeScript
- Stars
- 829
- Forks
- 260
- Avg merge
- 5h 43m
- Merged PRs (30d)
- 1
Description
Is your enhancement related to a problem? Please describe.
To make the documentation more visible we should move the documentation from the wiki into somewhere that's more discoverable.
Describe the solution you would like
We move the documentation into /documentation
Describe alternatives you have considered
Start linking the wiki in the readme so that more extension developers are redirected there
Additional context
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
Review the existing wiki material and the repository README first. Determine what documentation must be moved into /documentation and how existing references should point to it. Done means the relevant wiki content is present in the repository and discoverable from the project entry points.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100