Repository navigation
docs: align README install and safety sections - #1
Merged
Merged
Conversation
9 tasks done
There was a problem hiding this comment.
Pull request overview
Updates the project README to match the newer public preset README structure, adding a metadata header, installation examples, and explicit safety/boundary notes while keeping preset behavior unchanged.
Changes:
- Added README metadata fields (status, priority) and updated the “Requires” line formatting.
- Added an Install section with release-zip and local-dev installation examples.
- Added a Safety / Grenzen section clarifying what the preset does and does not do.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (2)
README.md:76
- In the prerequisites list, “GitHub Spec Kit CLI” uses a different product spelling than the rest of the README (“Spec-Kit”). For consistency (and to match the earlier reply that the README now uses
Spec-Kitconsistently), update this to “GitHub Spec-Kit CLI”.
1. kompatible GitHub Spec Kit CLI;
README.md:82
- This English prerequisite sentence still says “GitHub Spec Kit CLI” (no hyphen), while the rest of the README uses “Spec-Kit”. Align this product name spelling here too.
*Before installation, use a compatible GitHub Spec Kit CLI, a valid Spec-Kit
Comment on lines
+179
to
+183
| Prüfe zusätzlich, ob nutzerseitige Artefakte im Plan benannt sind und ob N/A | ||
| für WCAG, Bilingualität oder CEFR B2 begründet wurde. | ||
|
|
||
| *Also verify that user-facing artifacts are named in the plan and that N/A | ||
| decisions for WCAG, bilingual delivery, or CEFR B2 are justified.* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.