Move Claude Code to Getting Started Tools section#789
Conversation
trmartin4
changed the title
Deploying contributing-docs with
|
| Latest commit: |
23e479b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://289076b2.contributing-docs.pages.dev |
| Branch Preview URL: | https://move-claude-to-getting-start.contributing-docs.pages.dev |
|
New Issues (1)Checkmarx found the following issues in this Pull Request
Fixed Issues (2)Great job! The following issues were fixed in this Pull Request
|
|
@theMickster this was extracted from #766, but I believe it follows the guidance we'd discussed in that context and I'd welcome any feedback you have. |
theMickster
left a comment
theMickster
left a comment
There was a problem hiding this comment.
I think we're 95% of the way there for the changes. I still think we are a little too verbose in a few area for a getting started setup guide. We have so many things manual to do in order to get a development environment working that any extra context is too much and will be overlooked.
| requirements. All marketplace plugins are maintained by the Bitwarden team and include comprehensive | ||
| documentation, testing, and security validation. | ||
|
|
||
| You should install the marketplace plugins using the `/plugin` command: |
There was a problem hiding this comment.
❌ Instead of these instructions that duplicate what is in the repo's README.md, let's instead instruct them to the README.md and to install these plugins.
I specifically used the URLs because I don't think we should duplicate setup insturctions.
There was a problem hiding this comment.
Are you suggesting that we list all the plugins, or just the links to those 3?
There was a problem hiding this comment.
Those are the three plugins that are the ones we recommend that everyone has installed. So in the spirit that I think we are going for here (precise instructions for every engineer to follow), then I think it's best to either link to these or mention them as the ones to install.
The other plugins that are there (and soon to be there with lots of great PRs and ideas flowing!!) will not be applicable to all engineers.
There was a problem hiding this comment.
Alternative suggestion -- link to a readme page in that repo that presents the guide for what to install. Maintain it there and not here.
There was a problem hiding this comment.
@theMickster did you want to create that page, or would you like me to?
There was a problem hiding this comment.
I modified the ai-plugins section to reference the README in 60dc9cc (this PR). This way when we update it to have more explicit instructions it'll reference it for us.
Co-authored-by: Mick Letofsky <mletofsky@bitwarden.com>
Co-authored-by: Mick Letofsky <mletofsky@bitwarden.com>
Co-authored-by: Mick Letofsky <mletofsky@bitwarden.com>
Co-authored-by: Mick Letofsky <mletofsky@bitwarden.com>
Bitwarden Claude Code ReviewOverall Assessment: APPROVE This PR moves Claude Code setup instructions from No findings were identified. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
|
I think a minor change to the plugin section and this is knocked outta the park! Great work here @trmartin4. |
| requirements. All marketplace plugins are maintained by the Bitwarden team and include comprehensive | ||
| documentation, testing, and security validation. | ||
|
|
||
| You should install the marketplace plugins using the `/plugin` command: |
There was a problem hiding this comment.
Alternative suggestion -- link to a readme page in that repo that presents the guide for what to install. Maintain it there and not here.
3 participants
📔 Objective
Extracted from the larger #766 PR, where this was combined with changes to include a recommended use of Claude for code review.
This separate change proposes to move the Claude Code setup into the Getting Started section, so that it can be referenced automatically in our onboarding docs.
In addition, it cleans up some of the prescriptive and obsolete recommendations, instead leaning on Anthropic docs so we don't have to keep them up to date.