Skip to content

fix(security): apply ICP brand voice to security guides#234

Merged
marc0olo merged 6 commits into
docs/security-portfrom
docs/security-brand-voice
May 11, 2026
Merged

fix(security): apply ICP brand voice to security guides#234
marc0olo merged 6 commits into
docs/security-portfrom
docs/security-brand-voice

Conversation

@marc0olo
Copy link
Copy Markdown
Member

@marc0olo marc0olo commented May 11, 2026

Summary

  • "dapp"/"dapps" → "app"/"apps" across all 12 security guide files; repository names in URLs preserved (nns-dapp, encrypted-notes-dapp), link labels updated (NNS app, encrypted notes)
  • "smart contract(s)" → "canister(s)" in decentralization.md, including the section heading and the blockchains admonition note
  • Em-dashes removed from <!-- Upstream: --> comments in all 11 remaining files (identity-and-access-management.mdx was already fixed in a previous commit)
  • Informal phrasing removed in data-integrity-and-authenticity.md: "we will club composite_query" and "best of both worlds"
  • Garbled sentence fixed in identity-and-access-management.mdx (mobile II section): the original had a sentence fragment mid-paragraph from a copy-paste error
  • "DAO" removed from prose in decentralization.md; replaced with "community governance", "governance framework", and "custom governance canister" following the convention established in PR docs: migrate Learn Hub 'How does ICP work?' content into developer docs #208
  • "decentralized governance system" → "governance framework" throughout decentralization.md
  • composite_query description corrected in data-integrity-and-authenticity.md: "query call" → "query methods" (composite_query is a method type, not a call type)
  • "off-chain" → "offchain" / "external" in decentralization.md; bare "onchain"/"offchain" category labels replaced with descriptive terms ("external components", "hosted as canisters")
  • "tamper-resistant" → "tamperproof" in observability-and-monitoring.md (one word, per brand guide)
  • "on-chain" → "stored in the canister" in observability-and-monitoring.md

Sync recommendation

informed by dfinity/portal — content is derived from the portal source but diverges intentionally for brand voice compliance; no sync back to portal is expected.

- Replace all standalone "dapp"/"dapps" with "app"/"apps" across 9 files;
  preserve repo names (nns-dapp, encrypted-notes-dapp) in URLs and update
  their link labels (NNS app, encrypted notes example app)
- Replace "smart contract(s)" with "canister(s)" in decentralization.md,
  including section heading and the blockchains admonition note
- Remove em-dashes from Upstream comments in all 11 remaining files
  (identity-and-access-management.mdx was already fixed)
- Remove informal phrasing in data-integrity-and-authenticity.md:
  "club composite_query" and "best of both worlds"
- Fix garbled sentence in identity-and-access-management.mdx mobile II section
@marc0olo marc0olo requested a review from a team as a code owner May 11, 2026 12:57
marc0olo added 5 commits May 11, 2026 15:27
…ion.md

Aligns with wording convention established in PR #208 (SNS framework page),
which avoids "DAO" in prose and uses "community-governed" constructions instead.

- "Full decentralization using a DAO" heading -> "Full community governance"
- "DAO evolves" link text -> "community governance evolves"
- "building your own DAO" -> "building your own governance system"
- "alternative to DAO control" -> "alternative to community governance"
- "implement a DAO from scratch" -> "implement a custom governance canister"
- "basic DAO example" link text -> "basic governance example"
- "the DAO is controlled by itself" -> "the governance canister is controlled by itself"
…mperproof

Per updated brand voice rules:
- offchain components -> external components/infrastructure (decentralization.md)
- tamper-resistant -> tamperproof (observability-and-monitoring.md)
@marc0olo marc0olo merged commit 3446af0 into docs/security-port May 11, 2026
3 checks passed
@marc0olo marc0olo deleted the docs/security-brand-voice branch May 11, 2026 14:27
marc0olo added a commit that referenced this pull request May 12, 2026
## Summary

- **\"dapp\"/\"dapps\" → \"app\"/\"apps\"** across all 12 security guide
files; repository names in URLs preserved (`nns-dapp`,
`encrypted-notes-dapp`), link labels updated (`NNS app`, `encrypted
notes`)
- **\"smart contract(s)\" → \"canister(s)\"** in `decentralization.md`,
including the section heading and the blockchains admonition note
- **Em-dashes removed from `<!-- Upstream: -->` comments** in all 11
remaining files (`identity-and-access-management.mdx` was already fixed
in a previous commit)
- **Informal phrasing removed** in `data-integrity-and-authenticity.md`:
\"we will club composite_query\" and \"best of both worlds\"
- **Garbled sentence fixed** in `identity-and-access-management.mdx`
(mobile II section): the original had a sentence fragment mid-paragraph
from a copy-paste error
- **\"DAO\" removed from prose** in `decentralization.md`; replaced with
\"community governance\", \"governance framework\", and \"custom
governance canister\" following the convention established in PR #208
- **\"decentralized governance system\" → \"governance framework\"**
throughout `decentralization.md`
- **`composite_query` description corrected** in
`data-integrity-and-authenticity.md`: \"query call\" → \"query methods\"
(composite_query is a method type, not a call type)
- **\"off-chain\" → \"offchain\" / \"external\"** in
`decentralization.md`; bare \"onchain\"/\"offchain\" category labels
replaced with descriptive terms (\"external components\", \"hosted as
canisters\")
- **\"tamper-resistant\" → \"tamperproof\"** in
`observability-and-monitoring.md` (one word, per brand guide)
- **\"on-chain\" → \"stored in the canister\"** in
`observability-and-monitoring.md`

## Sync recommendation

`informed by dfinity/portal` — content is derived from the portal source
but diverges intentionally for brand voice compliance; no sync back to
portal is expected.
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.

1 participant