Skip to content

docs: align README install and safety sections - #1

Merged
hindermath merged 5 commits into
mainfrom
codex/readme-install-safety-20260718214834
Jul 18, 2026
Merged

hindermath merged 5 commits into
mainfrom
codex/readme-install-safety-20260718214834

Conversation

@hindermath

Copy link
Copy Markdown
Owner

Updates the preset README to match the newer public preset README shape: metadata block, installation examples, and explicit safety/boundary notes. No preset behavior or version is changed.

Copilot AI review requested due to automatic review settings July 18, 2026 19:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the preset’s README to match the newer public README structure by adding a small metadata block, concrete install examples, and explicit safety/boundary notes—without changing preset behavior or versions.

Changes:

  • Added README metadata fields (status, priority) and refined the requirements line.
  • Added installation examples for tag-based and local dev installs.
  • Added a “Safety / Grenzen” section clarifying non-goals and authority boundaries.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Copilot AI review requested due to automatic review settings July 18, 2026 21:55

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md Resolved
Copilot AI review requested due to automatic review settings July 18, 2026 21:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

README.md:136

  • This sentence is a bit ungrammatical/ambiguous (“decisions such as C3A/C5 N/A”). Consider rephrasing so it’s clear you mean setting C3A/C5 to N/A (or marking it as N/A).
- Architecture applicability decisions such as C3A/C5 `N/A` require explicit
  project evidence.

Copilot AI review requested due to automatic review settings July 18, 2026 22:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Copilot AI review requested due to automatic review settings July 18, 2026 22:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

README.md:28

  • In the English summary, N/A is referenced without backticks (“justified N/A decisions”), while elsewhere in the README N/A is consistently formatted as code. This looks like a missed spot and makes formatting inconsistent.
*The quality goal is reviewable architecture reasoning: trust boundaries,
attack surfaces, security quality goals, cloud dependencies, S-ADRs, and
justified N/A decisions should be visible before implementation.*

@hindermath
hindermath merged commit a13d385 into main Jul 18, 2026
1 check passed
@hindermath
hindermath deleted the codex/readme-install-safety-20260718214834 branch July 18, 2026 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants