Docs/documentation standard compliance - #204
Conversation
A created repo should not ship a README about being a template, so the file is now the skeleton that new repos start from: what the repo is, a Getting started section linking the contributing site, a Structure map for monorepos, and Related repositories. Commenting decisions were made based on what is true of an initialized repository. Git hooks remain rendered, but instructions on updating linters do not
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE Reviewed the README skeleton and Code Review Details
Also noted, not blocking: the README links |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| <!-- | ||
| Template guidance — delete this comment when customizing your new repo. | ||
|
|
||
| Run /bitwarden-init:init to generate this file from an analysis of your |
There was a problem hiding this comment.
❓ QUESTION: Will /bitwarden-init:init resolve in a fresh clone of a repo made from this template?
Details
.claude/settings.json declares extraKnownMarketplaces for bitwarden-marketplace, which makes the marketplace known but does not install or enable any plugin from it. Without an enabledPlugins entry (or a prior /plugin install), /bitwarden-init:init is an unknown slash command, and this comment is the only actionable instruction the file gives.
Two options depending on intent:
- Enable it in
.claude/settings.jsonso the command works out of the box:"enabledPlugins": { "bitwarden-init@bitwarden-marketplace": true }
- Or, if you'd rather not permanently enable a one-shot bootstrap plugin in every derived repo, name the install step in the comment:
Run /plugin install bitwarden-init@bitwarden-marketplace, then /bitwarden-init:init …
Either way the reader isn't left guessing why the command isn't there.
withinfocus
left a comment
withinfocus
left a comment
There was a problem hiding this comment.
You have a bold set of expectations for the Claude instructions but the init plugin should cover us.
2 participants
📔 Objective
Ensure compliance with new README requirements from the get-go. (see documentation standards PR)
This repository is only responsible for initializing repositories in a good state, so the actual long-term requirements of READMEs are kept in contributing-docs