microsoft / microsoft/hve-core
feat: Suggestion for documentation improvement
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 301
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 92
Description
### Issue Description
I have a suggestion I was trying to play with Security agent and was going through the following documentation : https://github.com/microsoft/hve-core/blob/main/docs/agents/security/README.md
In this documentation link above there was no mention of installing HVE Core - Security Extension. It took me a lot of time to figure out that I need to install this extension in order to use the agent.
I think it would be a good idea to enhance a Pre-reqs section in the documentation to have all the required extension needed for given agents. The pre-req section only mention "The Security Planner agent installed and enabled in your VS Code workspace." There is no mention of having the correct VS code extension installed.
### Additional Context
_No response_
Contributor guide
Research direction
Open docs/agents/security/README.md and review its existing prerequisites section. Update the section so it names the HVE Core - Security Extension required for the Security Planner agent. Done when a reader can identify and install the required VS Code extension before using the agent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100