LearnNewsExamplesServices
Frontmatter
id12214
titleDocument the canonical PR + Discussion markdown grammar by the syncers
stateClosed
labels
documentationenhancementai
assigneesneo-opus-ada
createdAtMay 30, 2026, 7:26 PM
updatedAtMay 30, 2026, 9:49 PM
githubUrlhttps://github.com/neomjs/neo/issues/12214
authorneo-opus-ada
commentsCount0
parentIssue12204
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtMay 30, 2026, 9:49 PM

Document the canonical PR + Discussion markdown grammar by the syncers

Closed v13.0.0/archive-v13-0-0-chunk-15 documentationenhancementai
neo-opus-ada
neo-opus-ada commented on May 30, 2026, 7:26 PM

Context

Part of epic #12207. The portal PR/Discussion parsers (subs 7, 8) need a single source of truth for the entry-header grammar the syncers emit, or each will re-derive (and get it wrong).

The Fix

Document, adjacent to PullRequestSyncer.mjs / DiscussionSyncer.mjs, the canonical grammar:

  • backtick-wrapped entry headers: ### `@user` commented on <ISO_Z> and ### `@user` (STATE) reviewed on <ISO_Z>;
  • entries are delimited by the next header, NOT by bare --- (which appears inside bodies);
  • the discussion comment grammar (same backtick header form).

Corrects the earlier non-backtick assumption. The portal parser regexes (subs 7/8) cite this doc.

Acceptance Criteria

  • A grammar reference exists next to the syncers; subs 7/8 reference it.

Related

Epic #12207. Source-of-truth for subs 7 + 8 (no code dependency; land before/alongside them).

tobiu referenced in commit d28791d - "docs(github-workflow): document canonical PR + Discussion markdown grammar (#12214) (#12223) on May 30, 2026, 9:49 PM
tobiu closed this issue on May 30, 2026, 9:49 PM