Skip to content

[Chore][Repository] Remove README Important security admonition #207

Description

@miso-develop

Related

Owner

  • ACTIVE_ROLE: implementation
  • DOMAIN: infra

State

READY_FOR_REVIEW

Baseline

Specification baseline: main = 40f7061eb89dcc676599d7f74f1b45037e589ea2.

Context

Both public landing READMEs currently contain a top-level GitHub Markdown admonition:

> [!IMPORTANT]
> This is a public repository...

and the Japanese equivalent.

The repository already has authoritative secret-handling/security policy in SECURITY.md.

The human owner requested removal of the README Important admonition, with the condition that the agent-facing policy must still point to SECURITY.md.

Specification checked the current AGENTS.md and confirmed that requirement is already satisfied. It contains multiple explicit security-policy references, including:

  • credential-like values must follow SECURITY.md;
  • implementation bootstrap reads SECURITY.md;
  • security-sensitive changes must reference SECURITY.md.

Therefore this Task must not add redundant AGENTS wording solely to satisfy this request.

Objective

Remove the prominent README Important/admonition block while retaining SECURITY.md as the authoritative security policy and preserving normal Security links elsewhere in the READMEs.

Scope

1. English README

In README.md:

  • remove the complete opening [!IMPORTANT] admonition block that begins with the public-repository warning;
  • remove both the marker and its admonition body;
  • do not leave an empty blockquote or blank warning shell.

2. Japanese README

In README.ja.md:

  • remove the equivalent opening [!IMPORTANT] admonition block;
  • preserve EN/JA structural parity.

3. Preserve normal SECURITY references

Do not remove ordinary documentation references to SECURITY.md, including the current:

  • authoritative security-contract link;
  • Security Policy documentation link;
  • development/contribution reminder to follow SECURITY.md.

The request removes the prominent README admonition, not the repository's security policy or all links to it.

4. AGENTS.md

No change is required to AGENTS.md for this Task because current main already explicitly requires agents to read/follow SECURITY.md.

Do not edit AGENTS.md unless a fresh pre-implementation check shows those references were removed by another integrated change.

Non-goals

  • Do not weaken or edit SECURITY.md.
  • Do not change secret-handling requirements.
  • Do not remove Security documentation links elsewhere in README.
  • Do not change product behavior, release policy, Protocol, Vault, cryptography, Device, or Web runtime behavior.
  • Do not rewrite unrelated README sections.

Acceptance

  • README.md no longer contains the opening [!IMPORTANT] admonition.
  • README.ja.md no longer contains the corresponding opening admonition.
  • No empty admonition/blockquote remains.
  • Ordinary SECURITY.md references remain in both READMEs.
  • AGENTS.md still explicitly requires use/reference of SECURITY.md.
  • No redundant AGENTS edit is made if that contract remains present.
  • EN/JA README structure remains equivalent.
  • Only documentation changes are introduced.
  • Documentation/secret-policy checks required by the repository remain green.

Collision / coordination

At Specification time, open PR #206 is Web Serial lifecycle work and does not own README or AGENTS files.

Implementation must still re-check current ownership before mutation.

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions