Skip to content

docs: sync reference specs 1:1 from portal and internet-identity#128

Merged
marc0olo merged 2 commits into
mainfrom
docs/portal-content-1to1
Apr 21, 2026
Merged

docs: sync reference specs 1:1 from portal and internet-identity#128
marc0olo merged 2 commits into
mainfrom
docs/portal-content-1to1

Conversation

@marc0olo
Copy link
Copy Markdown
Member

Summary

  • ic-interface-spec: replaced overview stub with full 9,670-line portal spec; changelog inlined; Docusaurus {#anchor} heading IDs handled via new remark-heading-id plugin
  • http-gateway-spec: was a hand-written rewrite — replaced 1:1 from portal
  • candid-spec: replaced 1:1 from portal candid-ref.mdx (was ~57% complete)
  • internet-identity-spec: replaced 1:1 from dfinity/internet-identity docs/ii-spec.mdx; Candid interface inlined from internet_identity.did; new .sources/internetidentity submodule added (same pattern as portal uses)
  • glossary: replaced 1:1 from portal (was ~39% of terms)
  • Sidebar order: specs first (IC Interface → HTTP Gateway → Candid → II), then practical references, glossary last
  • All internetcomputer.org/docs and portal-internal absolute URLs replaced with internal paths; every replacement documented in per-file <!-- Link replacements --> comments

Sync recommendation

  • ic-interface-spec.md — sync from dfinity/portal docs/references/ic-interface-spec.md + _attachments/interface-spec-changelog.md
  • http-gateway-spec.md — sync from dfinity/portal docs/references/http-gateway-protocol-spec.md
  • candid-spec.md — sync from dfinity/portal docs/references/candid-ref.mdx
  • internet-identity-spec.md — sync from dfinity/internet-identity docs/ii-spec.mdx
  • glossary.md — sync from dfinity/portal docs/references/glossary.mdx

- Replace ic-interface-spec.md with full portal spec (9,670 lines),
  changelog inlined, Docusaurus {#anchor} IDs handled via new
  remark-heading-id plugin
- Replace http-gateway-spec.md 1:1 from portal (was a rewrite)
- Replace candid-spec.md 1:1 from portal candid-ref.mdx
- Replace internet-identity-spec.md 1:1 from dfinity/internet-identity
  docs/ii-spec.mdx; Candid interface inlined from internet_identity.did
- Replace glossary.md 1:1 from portal (was ~39% complete)
- Add dfinity/internet-identity as .sources/internetidentity submodule,
  pinned to same commit as portal (af980848, NNS proposal-136786-4)
- Reorder reference sidebar: specs first (IC, HTTP Gateway, Candid, II),
  then practical references, glossary last
- All portal-internal and banned URLs replaced with internal paths;
  replacements documented in per-file comments
- Add 'sync from' keyword to all Upstream comments
- Fix broken ./http-gateway-protocol-spec.md → ./http-gateway-spec.md link in ic-interface-spec
- Redact internetcomputer.org/docs pattern from link-replacement comments
@marc0olo marc0olo merged commit 9e9c169 into main Apr 21, 2026
2 checks passed
@marc0olo marc0olo deleted the docs/portal-content-1to1 branch April 21, 2026 16:58
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