Skip to content

Docs/documentation standard compliance - #204

Open
MGibson1 wants to merge 4 commits into
mainfrom
docs/documentation-standard-compliance
Open

MGibson1 wants to merge 4 commits into
mainfrom
docs/documentation-standard-compliance

Conversation

@MGibson1

@MGibson1 MGibson1 commented Aug 4, 2026 •

Copy link
Copy Markdown
Member

📔 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

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
@github-actions

github-actions Bot commented Aug 5, 2026 •

Copy link
Copy Markdown

🤖 Bitwarden Claude Code Review

Overall Assessment: APPROVE

This PR rewrites README.md and .claude/CLAUDE.md into skeletons that follow the documentation standard. Each file carries a template-guidance comment to delete when a new repo is set up. The existing Git hooks instructions stay, and the linter-customization notes move into an HTML comment. The changed Claude configuration was scanned for credentials and committed local settings and is clean; both earlier review threads are resolved, and no new findings came up.

Comment thread .claude/CLAUDE.md

@withinfocus withinfocus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have a bold set of expectations for the Claude instructions but the init plugin should cover us.

@withinfocus

Copy link
Copy Markdown
Contributor

What's the latest here?

@MGibson1
MGibson1 marked this pull request as ready for review October 15, 2026 19:12
@MGibson1
MGibson1 requested review from a team as code owners October 15, 2026 19:12
@MGibson1

Copy link
Copy Markdown
Member Author

Those expectations were pulled from the linked confluence doc. Doing it this way allows us to remove confluence read requirements from automated initial documentation.

I don't see anything in here I'd like to change, this was draft waiting on plugins to update and those are now moving again. I'm comfortable moving this forward again, now.

@MGibson1
MGibson1 enabled auto-merge (squash) October 15, 2026 20:18
@github-actions

github-actions Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Claude Code validation

Result: Pass

Reviewed the one changed Claude file, .claude/CLAUDE.md, from the PR-head snapshot in .claude-pr/. The security scan is clean — no credentials, sensitive paths, or directives that loosen the harness — and the guidance comment addresses the human customizing the repo rather than attempting to direct this review. The previous round's finding (a pointer to a non-existent .claude/CONTRIBUTING.md) no longer appears at the head, and nothing new cleared the filter; the empty section headings are deliberate placeholders for bitwarden-init, not missing content.

Not covered: The external link on line 8 (github.com/bitwarden/ai-plugins/.../bitwarden-init) and its claim that the listed headings are the exact ones that plugin requires could not be verified — WebFetch was not permitted in this run. The on-disk reference and import checks did run and found nothing dangling.

Comment thread .claude/CLAUDE.md Outdated
Comment thread .claude/CLAUDE.md Outdated
@MGibson1
MGibson1 requested a review from withinfocus October 15, 2026 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review Request a Claude code review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants