docs(security): address post-merge feedback from Robin on PR 204#253
Open
marc0olo wants to merge 3 commits into
Open
docs(security): address post-merge feedback from Robin on PR 204#253marc0olo wants to merge 3 commits into
marc0olo wants to merge 3 commits into
Conversation
marc0olo
force-pushed
the
docs/security-robin-feedback
branch
from
e8320f5 to
d529721
Compare
|
🤖 Here's your preview: https://krmfk-uyaaa-aaaam-ai7vq-cai.icp0.io |
- identity-and-access-management.mdx: link "ICP JavaScript agent" to
developer-tools#javascript--typescript at both occurrences (lines 82, 102)
- data-integrity-and-authenticity.md: add calling-from-clients link after
update/query/composite_query intro; add certified-variables guide link
after certified data concept paragraph
- https-outcalls.md: link inline "pricing" to cycles-costs#https-outcalls
- observability-and-monitoring.md: restore two original portal sections
("Expose metrics from your canister" and "Do not publicly reveal a
canister's cycles balance") which had been collapsed into a single
generic section in the 1:1 port
- references/message-execution-properties.md: convert Property 1–11 from
bold bullet points to #### subheadings so they are directly linkable
- references/index.md: add message-execution-properties.md to the
Specifications section so it appears in the navigation
The security context is about query call trust model, not agent routing mechanics. inter-canister-calls#query-vs-update-calls has the Trust model row that maps directly onto the certified variables concern.
- inter-canister-calls.md: update Property 4, 5, 6 cross-links to use new anchors (#property-4, #property-5, #property-6) now that Properties are #### subheadings; two were stale #message-execution-properties anchors, two were plain text with no link at all - message-execution-properties.md: add sidebar order: 11 so the page appears in its correct position in the sidebar (before http-gateway=12) - glossary.md: move from order: 15 to order: 17 to resolve conflict with verifiable-credentials-spec.md (also order: 15); Terminology belongs last per the index grouping - references/index.md: move Message Execution Properties to second in the Specifications section, directly after IC Interface Spec; it is more foundational than HTTP Gateway or Candid, complementing the IC spec's formal execution model
marc0olo
force-pushed
the
docs/security-robin-feedback
branch
from
207e10c to
2451df5
Compare
robin-kunzler
approved these changes
May 13, 2026
There was a problem hiding this comment.
Thanks a lot @marc0olo !
Only thing that still seems to need fixing is the navigation entry for message exec properties, see comment below.
Otherwise good to go, approving!
| ## Specifications | ||
|
|
||
| - **[IC Interface Specification](ic-interface-spec/index.md)**: System API, HTTPS interface, certified data, management canister, and formal specification of the Internet Computer. | ||
| - **[Message Execution Properties](message-execution-properties.md)**: The 11 properties governing atomicity, ordering, inter-canister call delivery, and cycle handling in ICP message execution. |
There was a problem hiding this comment.
Hm somehow I don't see this entry in the navigation bar. Is something missing to make this appear there?
https://krmfk-uyaaa-aaaam-ai7vq-cai.icp0.io/references/message-execution-properties/
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
2 participants
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.
Summary
Addresses all feedback from @robin-kunzler posted on PR #204 after merge.
identity-and-access-management.mdx: Link both mentions of "ICP JavaScript agent" to the developer-tools page (#javascript--typescriptsection), rather than the GitHub repo as originally suggested; internal docs link is more useful for readersdata-integrity-and-authenticity.md: Add link tocalling-from-clients.mdafter the update/query/composite_query intro paragraph; append certified-variables guide link at the end of the certified data concept paragraphhttps-outcalls.md: Link inline "pricing" directly tocycles-costs.md#https-outcallsanchorobservability-and-monitoring.md: Restore the two original portal sections ("Expose metrics from your canister" and "Do not publicly reveal a canister's cycles balance") that had been collapsed into a single generic section during the 1:1 portreferences/message-execution-properties.md: Convert Property 1–11 from bold bullet points to####subheadings so cross-links (e.g. "Property 5") can anchor directlyreferences/index.md: Addmessage-execution-properties.mdto the Specifications section so it appears in the navigation (Robin reported the page was not findable)Note on developer-tools links: The two links in
identity-and-access-management.mdxcurrently point toreferences/developer-tools.md#javascript--typescript. When PR #251 (infra/developer-tools-section) merges, those paths will move todeveloper-tools/index.md#javascript--typescript. A comment has been left on PR #251 to flag this. Whichever PR merges second handles the one-line update; the build will catch it.Sync recommendation
sync from dfinity/portal — building-apps/security/observability-and-monitoring.mdx