Skip to content

docs: clarity polish (SafeMode framing, CriticMarkup scope, cross-refs) - #194

Merged
dereuromark merged 1 commit into
mainfrom
docs/low-polish
Jun 21, 2026
Merged

docs: clarity polish (SafeMode framing, CriticMarkup scope, cross-refs)#194
dereuromark merged 1 commit into
mainfrom
docs/low-polish

Conversation

@dereuromark

Copy link
Copy Markdown
Contributor

Low-priority clarity items from the full-docs re-audit (follow-up to #191/#192/#193).

  • security.md - heading Relationship to the spec's SafeMode read as if SafeMode were normative. Reframed to Beyond the baseline: SafeMode and Profiles; the page baseline is the normative default, SafeMode/Profile are optional implementation-level policy layered on top.
  • dismissed-syntax.md - the CriticMarkup entry sat in a dismissal doc but its status said "Included in spec". Scoped the heading to the dismissed doubled-marker form and added a note that the feature itself was adopted (single markers, section 4.14).
  • index.md - glossed the first Djot mention on the home page (it was used before being introduced); dropped an em dash.
  • comparison.md / markup-languages.md - cross-linked the two overlapping comparison pages and stated each page's scope (Carve-centric vs broad neutral survey).

Docs build passes.

…s, page cross-refs)

- security.md: reframe "Relationship to the spec's SafeMode" heading -> "Beyond
  the baseline: SafeMode and Profiles"; clarify the page baseline is the
  normative default and SafeMode/Profile are optional implementation-level
  policy layered on top.
- dismissed-syntax.md: scope the CriticMarkup entry to the dismissed
  doubled-marker form; note the feature itself was adopted (single markers,
  section 4.14), so it is no longer mistaken for a wholesale dismissal.
- index.md: gloss the first "Djot" mention on the home page; drop em dash.
- comparison.md / markup-languages.md: cross-link the two and state each
  page's scope (Carve-centric vs broad neutral survey).
@dereuromark dereuromark added the documentation Improvements or additions to documentation label Jun 21, 2026
@dereuromark
dereuromark merged commit 17a6310 into main Jun 21, 2026
3 checks passed
@dereuromark
dereuromark deleted the docs/low-polish branch June 21, 2026 16:48
dereuromark added a commit that referenced this pull request Jun 27, 2026
…s, page cross-refs) (#194)

- security.md: reframe "Relationship to the spec's SafeMode" heading -> "Beyond
  the baseline: SafeMode and Profiles"; clarify the page baseline is the
  normative default and SafeMode/Profile are optional implementation-level
  policy layered on top.
- dismissed-syntax.md: scope the CriticMarkup entry to the dismissed
  doubled-marker form; note the feature itself was adopted (single markers,
  section 4.14), so it is no longer mistaken for a wholesale dismissal.
- index.md: gloss the first "Djot" mention on the home page; drop em dash.
- comparison.md / markup-languages.md: cross-link the two and state each
  page's scope (Carve-centric vs broad neutral survey).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant