Revise agent guidelines and introduce documentation styleguide#380
Merged
Conversation
…tion - revise agent guidelines to clarify documentation standards - introduce styleguide for consistent writing and formatting - emphasize direct address and avoidance of gendered language
…atting - add missing periods at the end of sentences - standardize hyphenation in skill names (e.g., "Combat-Skill") - correct minor grammatical errors for clarity
Contributor
There was a problem hiding this comment.
Pull request overview
Diese PR führt einen neuen, verbindlichen Styleguide für die Community-Server-Dokumentation ein und überarbeitet eine große Anzahl bestehender Writerside-Seiten, um Terminologie, Typografie und Ansprache (durchgängig „du“) zu vereinheitlichen sowie gegenderte Sonderformen zu entfernen.
Changes:
- Neues
STYLEGUIDE.mdals zentrale Referenz für Sprache, Terminologie, Typografie und Writerside-Markup-Regeln. AGENTS.mdstark ausgebaut, um automatisierte/agentenbasierte Änderungen strikt an den Styleguide zu binden.- Breite Aktualisierung vieler Writerside-Themen (Survival/Event/General/Contribution) für konsistente Begriffe, Typografie (z. B. geschützte Leerzeichen), und „du“-Ansprache.
Reviewed changes
Copilot reviewed 85 out of 85 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Writerside/topics/survival-server/survival-server.topic | Landing-Text/Terminologie vereinheitlicht |
| Writerside/topics/survival-server/specials/survival-events.md | Event-Bezeichnungen & Typografie vereinheitlicht |
| Writerside/topics/survival-server/specials/specials.md | Begriffe/Typografie korrigiert |
| Writerside/topics/survival-server/specials/mechanics/changed-vanilla-mechanics.md | Terminologie/Typografie in Tabellen & Text |
| Writerside/topics/survival-server/skills/woodcutting.md | Skill-Bezug & Schreibweise korrigiert |
| Writerside/topics/survival-server/skills/skills.md | „du“-Ansprache + Terminologie |
| Writerside/topics/survival-server/skills/skill-system.topic | Karten-Summaries standardisiert |
| Writerside/topics/survival-server/skills/mining.md | Skill-Schreibweise + Kommasetzung |
| Writerside/topics/survival-server/skills/fishing.md | Skill-Schreibweise vereinheitlicht |
| Writerside/topics/survival-server/skills/farming.md | Skill-Schreibweise vereinheitlicht |
| Writerside/topics/survival-server/skills/combat.md | Skill-Schreibweise vereinheitlicht |
| Writerside/topics/survival-server/shop/shop-manage.md | Klarheit/„du“/Terminologie |
| Writerside/topics/survival-server/shop/shop-item-buy.md | Pronomen/Lesbarkeit verbessert |
| Writerside/topics/survival-server/shop/shop-chest.md | Formatierung + „nur“/„du“ |
| Writerside/topics/survival-server/plots/visualizer/visualizer/plot-visualizer.md | Befehle formatiert, Grammatik korrigiert |
| Writerside/topics/survival-server/plots/rename/rename/plot-rename.md | „du“-Ansprache & Grammatik |
| Writerside/topics/survival-server/plots/misc/misc/plot-other.md | Kommasetzung & Genitiv vereinheitlicht |
| Writerside/topics/survival-server/plots/members/members/plot-add-member.md | Grammatik/Blockquote-Format korrigiert |
| Writerside/topics/survival-server/plots/flags/flags/plot-edit-flags.md | Terminologie („Grundstücks-Flags“) & Typografie |
| Writerside/topics/survival-server/plots/expand/expand/plot-expand.md | „du“-Ansprache + Terminologie |
| Writerside/topics/survival-server/plots/create/create/plot-creation.md | Typografie (geschütztes Leerzeichen) + Begriffe |
| Writerside/topics/survival-server/map-downloads.md | Hyphenation/„du“-Ansprache in Beschreibungen |
| Writerside/topics/survival-server/lightblocks-itemframes-globebannerpatterns/light-blocks-and-invisible-item-frames-and-globe-banner-pattern.md | Genderformen entfernt, Typografie vereinheitlicht |
| Writerside/topics/survival-server/features.md | Terminologie (Survival-Server, Accounts) vereinheitlicht |
| Writerside/topics/survival-server/enchantments/custom-enchantments.md | QoL-Schreibweise, „du“, Typografie in Tabelle |
| Writerside/topics/survival-server/cosmetics/armorstand.md | Grammatik/Terminologie („Linksklick“, Items) |
| Writerside/topics/survival-server/commands/commands.md | Formulierungen/„du“/Warnhinweise geschärft |
| Writerside/topics/survival-server-whitelist.md | „du“-Ansprache + Tippfehler korrigiert |
| Writerside/topics/support.md | Ticket-Texte „du“-konform & typografisch bereinigt |
| Writerside/topics/spawns.md | Grammatik + „du“-Ansprache |
| Writerside/topics/reusablecontent/util.md | Snippets „du“-konform + Terminologie |
| Writerside/topics/mtr.md | Klarheit/Bindestriche („Support-Ticket“) |
| Writerside/topics/general-server/rules/rules-overview.topic | Titel/Startseite auf „Serverregeln“ |
| Writerside/topics/general-server/rules/pages/verified-mods.md | „du“-Ansprache + Typografie/Begriffe |
| Writerside/topics/general-server/rules/pages/rules.md | Genderformen entfernt, „du“-Ansprache, Typografie |
| Writerside/topics/general-server/ranks/team-member-overview.md | Überschrift sprachlich vereinheitlicht |
| Writerside/topics/general-server/ranks/rank-overview.topic | Summaries sprachlich präzisiert |
| Writerside/topics/general-server/ranks/rank-list-overview.md | „du“/Typografie/Terminologie in Rollenbeschreibungen |
| Writerside/topics/general-server/ranks/application-overview.md | Team-/Voice-Anforderungen sprachlich geglättet |
| Writerside/topics/general-server/questions/troubleshooting.md | Typografie/Bindestriche („Minecraft-Neustart“) |
| Writerside/topics/general-server/questions/faq.md | „du“-Ansprache + Typografie/Begriffe |
| Writerside/topics/general-server/join/how-to-join.md | „du“-Ansprache + Server-Bezeichnungen |
| Writerside/topics/general-server/friend/friend-system.md | Begriff „Freundschaftsinfo“ vereinheitlicht |
| Writerside/topics/general-server/economy/economy.md | „du“-Ansprache + Kommasetzung |
| Writerside/topics/general-server/clan/create-clan.md | Terminologie („Clan-Erstellung“) & Typografie |
| Writerside/topics/general-server/clan/clan-system.topic | „du“-Ansprache in Cards |
| Writerside/topics/general-server/clan/clan-more-info.md | Tippfehler „Discord“ + Typografie |
| Writerside/topics/general-server/clan/clan-management.md | Terminologie („Clan-Besitzer“) & Überschriften |
| Writerside/topics/event-server/how-to-take-part-in-an-event.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/tilted.md | Event-Titel/„du“/Typografie |
| Writerside/topics/event-server/events/stoneblock-event.md | „du“-Ansprache + Typografie/Kommas |
| Writerside/topics/event-server/events/skyblock.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/randomizer-event.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/oneblock-event.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/one-chunk.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/oceanblock.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/nether-event.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/limitless-heights.md | „du“-Ansprache + Satzbau |
| Writerside/topics/event-server/events/hardcore-event.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/flatworld.md | „du“-Ansprache + Challenge-Typografie |
| Writerside/topics/event-server/events/end-event.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/diamondevent.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/desert-event.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/creative2.md | Event-Namen/„du“/Typografie |
| Writerside/topics/event-server/events/crafting-challenge.md | „du“-Ansprache + Typografie |
| Writerside/topics/event-server/events/craftattack-cube-building.md | „du“-Ansprache + Terminologie |
| Writerside/topics/event-server/events/civilisation-event.md | Genderformen entfernt, Typografie vereinheitlicht |
| Writerside/topics/event-server/events/buildit2.md | „du“-Ansprache + Typografie (€, Zeiten) |
| Writerside/topics/event-server/events/building-event.md | „du“-Ansprache + Terminologie |
| Writerside/topics/event-server/events/anarchy-event.md | Typografie/Kommasetzung |
| Writerside/topics/event-server/events/500k-event.md | Event-Titel/„du“/Typografie |
| Writerside/topics/event-server/event-server.topic | Event-Server Benennung/Summaries |
| Writerside/topics/disclaimer.md | Satzbau/Interpunktion vereinheitlicht |
| Writerside/topics/contribution/documentation/write-documentation.md | GitHub/Writerside-Begriffe + Stil |
| Writerside/topics/contribution/documentation/update-project.md | Terminologie („aktualisieren“) + Links |
| Writerside/topics/contribution/documentation/publish-changes.md | Typografie („Pop-up“, „Commit-Nachricht“) |
| Writerside/topics/contribution/documentation/install-writerside.md | Writerside-Schreibweise + Grammatik |
| Writerside/topics/contribution/documentation/function-overviews.md | Writerside-Schreibweise + Grammatik |
| Writerside/topics/contribution/documentation/fork-repo.md | GitHub/Repository-Terminologie + Stil |
| Writerside/topics/contribution/documentation/doc-contribution.md | Terminologie („Dokumentationsbeitrag“) |
| Writerside/topics/contribution/documentation/create-merge-request.md | Grammatik („Gib…“, „bis…“) |
| Writerside/topics/contribution/documentation/contribution.md | Satzzeichen/Finalisierung |
| Writerside/topics/community-server-landing-page.topic | Landing-Page Terminologie + „du“ |
| STYLEGUIDE.md | Neuer Styleguide (Doc-Standard) |
| AGENTS.md | Agent-Regeln an Styleguide angepasst/erweitert |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request introduces a comprehensive style guide for the Community-Server documentation and applies major revisions to contribution guidelines and several documentation pages. The main focus is on unifying language (consistent use of "du"), removing gendered forms, standardizing terminology and typography, and clarifying technical requirements for contributions. It also updates Writerside-specific instructions and improves clarity and consistency across contribution-related docs.
Documentation standards and style:
STYLEGUIDE.mddefining language, terminology, gender rules, typography, and Writerside markup conventions for all documentation.AGENTS.mdwith strict rules for automated and manual contributions, enforcing the new style guide, language use, and Writerside markup preservation. [1] [2]Contribution process improvements:
doc-contribution.md,fork-repo.md,create-merge-request.md,contribution.md) for clarity, direct address ("du"), and technical accuracy (e.g., "Repository" vs. "Repo", "GitHub" spelling, up-to-date instructions). [1] [2] [3] [4]Landing page and terminology consistency:
These changes significantly raise the quality and consistency of the documentation and set clear standards for all future contributions.