Skip to content

fix(gdc): clarify prose wrapping rule#104

Open
puneetdixit200 wants to merge 1 commit into
KemingHe:mainfrom
puneetdixit200:fix/gdc-prose-wrapping/puneetdixit200
Open

fix(gdc): clarify prose wrapping rule#104
puneetdixit200 wants to merge 1 commit into
KemingHe:mainfrom
puneetdixit200:fix/gdc-prose-wrapping/puneetdixit200

Conversation

@puneetdixit200
Copy link
Copy Markdown

Clarifies the General Doc Constraints prose wrapping rule so agents do not insert hard newlines to simulate editor wrapping. Also updates the documentation-review checklist to flag hard-wrapped output instead of listing soft-wrapped output as a problem.

AI-assisted contribution: created with OpenAI Codex and manually reviewed.

closes #100

Changes

  • Updated the canonical General Doc Constraints asset and embedded skill copies from v1.1.0 to v1.1.1.
  • Reworded the prose rule to explicitly prohibit hard newlines used as visual wrapping.
  • Updated documentation-review checklist wording in both the skill and README.

Impact

  • Skills importing GDC should produce continuous physical lines for prose paragraphs and let renderers wrap text visually.

Notes

  • Validation: git diff --check passed.
  • Validation: confirmed no remaining GDC v1.1.0 prose wrapping text, old "Soft-wrapped bullets or prose" checklist text, or old "Never break a sentence across lines" wording under .agents.

Copilot AI review requested due to automatic review settings May 20, 2026 08:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the shared “General Doc Constraints” (GDC) prose-wrapping guidance to remove ambiguity that led agents to insert hard line breaks for visual wrapping, and aligns the documentation-review checklist to flag hard-wrapped output.

Changes:

  • Reworded the GDC Prose rule to explicitly prohibit hard newlines used for visual wrapping and require single-line paragraphs.
  • Bumped embedded GDC footer references from v1.1.0 to v1.1.1 across skills (and the canonical asset copy).
  • Updated the documentation-review “Output quality” checklist wording to flag hard-wrapped prose/bullets rather than “soft-wrapped” output.

Reviewed changes

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

Show a summary per file
File Description
.agents/skills/skill-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/skill-creation/assets/general-doc-constraints.md Updates canonical GDC prose rule + footer version to v1.1.1.
.agents/skills/readme-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/pull-merge-request-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/next-session-handoff/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/meeting-memo-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/meeting-agenda-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/living-design-documents/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/issue-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/dot-gitlab-sync/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/documentation-review/SKILL.md Updates checklist wording to flag hard-wrapping; updates embedded GDC prose rule + footer version.
.agents/skills/documentation-review/README.md Updates checklist wording to flag hard-wrapping in the skill’s README.
.agents/skills/contacts-management/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.
.agents/skills/commit-message-creation/SKILL.md Updates embedded GDC prose rule + footer version to v1.1.1.

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

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.

bug(general-doc-constraints): prose wrapping rule ambiguity causes pre-wrapped output

2 participants