Merge remote-tracking branch 'origin/master' into david/update-limits

dfinity · Nov 19, 2024 · 71009a3 · 71009a3
2 parents 82bca0f + 5d4944a
commit 71009a3
Show file tree

Hide file tree

Showing 167 changed files with 11,732 additions and 2,561 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -16,5 +16,13 @@ docs/developer-docssmart-contracts/advanced-features/simd.mdx @dfinity/execution
 docs/developer-docssmart-contracts/advanced-features/periodic-tasks.mdx @dfinity/execution
 docs/developer-docs/smart-contracts/best-practices/idempotency.mdx @dfinity/research @dfinity/product-security
 
+# The Interface Specification
+docs/references/_attachments/certificates.cddl @dfinity/canister-os
+docs/references/_attachments/http-gateway.did @dfinity/canister-os
+docs/references/_attachments/ic.did @dfinity/canister-os
+docs/references/_attachments/interface-spec-changelog.md @dfinity/canister-os
+docs/references/_attachments/requests.cddl @dfinity/canister-os
+docs/references/http-gateway-protocol-spec.md @dfinity/canister-os
+docs/references/ic-interface-spec.md @dfinity/canister-os
 
 src/pages/security-advisories.tsx @dfinity/product-security
diff --git a/.github/workflows/check-cddl-candid.yml b/.github/workflows/check-cddl-candid.yml
@@ -0,0 +1,27 @@
+name: "check cddl and candid files"
+on:
+  pull_request:
+    paths:
+      - docs/references/_attachments/certificates.cddl
+      - docs/references/_attachments/requests.cddl
+      - docs/references/_attachments/http-gateway.did
+      - docs/references/_attachments/ic.did
+  push:
+    branches:
+      - main
+jobs:
+  cddl-candid:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Check cddl files
+      run: |
+        docker run --rm -v $PWD/docs/references/_attachments:/workdir ghcr.io/anweiss/cddl-cli:0.9.1 compile-cddl --cddl /workdir/certificates.cddl
+        docker run --rm -v $PWD/docs/references/_attachments:/workdir ghcr.io/anweiss/cddl-cli:0.9.1 compile-cddl --cddl /workdir/requests.cddl
+    - name: Check candid files
+      run: |
+        curl -L https://github.com/dfinity/candid/releases/download/2023-07-25/didc-linux64 -o didc
+        chmod +x didc
+        ./didc check docs/references/_attachments/http-gateway.did
+        ./didc check docs/references/_attachments/ic.did
diff --git a/.gitmodules b/.gitmodules
@@ -11,10 +11,6 @@
 	path = submodules/internetidentity
 	url = https://github.com/dfinity/internet-identity.git
 	branch = main
-[submodule "submodules/interface-spec"]
-	path = submodules/interface-spec
-	url = https://github.com/dfinity/interface-spec.git
-	branch = public
 [submodule "submodules/samples"]
 	path = submodules/samples
 	url = https://github.com/dfinity/examples.git

diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ docs
 ├── motoko // Motoko documentation - submodule
 ├── references // reference documentation
 ├── samples // sample projects - submodule
-├── tutorials // tutorial series (developer journey, hackathon prep course, etc).
+├── tutorials // tutorial series (developer ladder, hackathon prep course, etc).
 ```
 
 # Contributing to the Dev Docs
@@ -155,7 +155,7 @@ Concept pages describe in more detail a specific concept of ICP. Concept pages s
 Concept pages should remain simple and high-level without providing unnecessary, in-depth details. Readers should be able to quickly understand the technology and its benefits, convincing them to continue learning more and begin developing using the technology.
 
 #### Tutorial
-A tutorial uses a step-by-step format to walk a user through a specific workflow. The Developer Journey is an example of a tutorial series.
+A tutorial uses a step-by-step format to walk a user through a specific workflow. The Developer Ladder is an example of a tutorial series.
 
 #### Reference
 A reference page provides low level detail into a feature or technology. API reference pages are an example that provide in-depth detail about different endpoints and methods. Some examples include:
@@ -394,10 +394,6 @@ The following submoules and their corresponding repos are currently used:
     - `/docs/current/references/ii-spec`
 	- GitHub Repo: https://github.com/dfinity/internet-identity.git
 
-- Interface Spec
-    - `/docs/current/references/ic-interface-spec `
-    - GitHub Repo: https://github.com/dfinity/interface-spec.git
-
 - Sample projects
     - `/docs/current/references/samples`
     - GitHub Repo: https://github.com/dfinity/examples.git

diff --git a/blog/news-and-updates/2023-08-16-update.mdx b/blog/news-and-updates/2023-08-16-update.mdx
@@ -1,6 +1,6 @@
 ---
 title: Developer weekly update August 16, 2023
-description: In this issue, we're excited to introduce the first portion of a new documentation series, Developer Journey, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
+description: In this issue, we're excited to introduce the first portion of a new documentation series, Developer Ladder, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
 tags: [Devs]
 image: /img/blog/dev-update-blog-aug-16.jpg
 ---
@@ -9,11 +9,11 @@ image: /img/blog/dev-update-blog-aug-16.jpg
 
 ![August 16 2023](../../static/img/blog/dev-update-blog-aug-16.jpg)
 
-Hey developers! Welcome to this week's developer weekly update. In this issue, we're excited to introduce the first portion of a new documentation series: Developer Journey, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`. 
+Hey developers! Welcome to this week's developer weekly update. In this issue, we're excited to introduce the first portion of a new documentation series: Developer Ladder, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
 
-## Introducing the Developer Journey
+## Introducing the Developer Ladder
 
-Today we're excited to introduce the new Developer Journey tutorial series! This series is designed to bring new developers on a detailed, diverse journey through development on the Internet Computer. The journey starts with 'pre-flight operations', which is an introductory level that provides context for the remainder of the journey, such as an overview of what ICP is, how it works, and how to set up your developer environment. Then, the journey will bring you through a series of modules to develop your skills and learn about additional ICP components in order to become an ICP astronaut! 
+Today we're excited to introduce the new Developer Ladder tutorial series! This series is designed to bring new developers on a detailed, diverse journey through development on the Internet Computer. The journey starts with 'pre-flight operations', which is an introductory level that provides context for the remainder of the journey, such as an overview of what ICP is, how it works, and how to set up your developer environment. Then, the journey will bring you through a series of modules to develop your skills and learn about additional ICP components in order to become an ICP astronaut!
 
 Overall, the journey will contain the following modules and components:
 
@@ -101,7 +101,7 @@ Overall, the journey will contain the following modules and components:
 
 - 5.6: Next steps.
 
-The first portion of this series, Level 0: Pre-flight operations, is out now and ready for you to follow along with! You can get started with your developer journey [here](https://internetcomputer.org/docs/current/tutorials/developer-journey/level-0/).
+The first portion of this series, Level 0: Pre-flight operations, is out now and ready for you to follow along with! You can get started with the Developer Ladder [here](https://internetcomputer.org/docs/current/tutorials/developer-journey/level-0/).
 
 ## Upcoming `dfx 0.15` release
 

diff --git a/blog/news-and-updates/2023-09-06-update.mdx b/blog/news-and-updates/2023-09-06-update.mdx
@@ -1,6 +1,6 @@
 ---
 title: Developer weekly update September 6, 2023
-description: This week, we're excited to talk about the next installment of the new documentation series developer journey, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
+description: This week, we're excited to talk about the next installment of the new documentation series Developer ladder, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
 tags: [Devs]
 image: /img/blog/dev-update-blog-sept-6.jpg
 ---
@@ -9,13 +9,13 @@ image: /img/blog/dev-update-blog-sept-6.jpg
 
 ![September 6 2023](../../static/img/blog/dev-update-blog-sept-6.jpg)
 
-Hello devs and welcome to this week's issue of developer weekly! This week, we're excited to talk about the next installment of the new documentation series developer journey, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
+Hello devs and welcome to this week's issue of developer weekly! This week, we're excited to talk about the next installment of the new documentation series developer ladder, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
 
 Let's get into it! 
 
-## Developer journey level 1
+## Developer ladder level 1
 
-The second level of the developer journey tutorial series is now live on the developer docs! In this level, level 1, we begin to dive into the building blocks of developing on ICP, such as learning about Motoko fundamentals, developing a simple poll dapp, and learning about canister deployment and management. Modules in this level include:
+The second level of the developer ladder tutorial series is now live on the developer docs! In this level, level 1, we begin to dive into the building blocks of developing on ICP, such as learning about Motoko fundamentals, developing a simple poll dapp, and learning about canister deployment and management. Modules in this level include:
 
 - [1.1: Exploring a live demo](/docs/current/tutorials/developer-journey/level-1/1.1-live-demo):
 
@@ -90,7 +90,7 @@ In this module, you can learn about:
     - Setting the canister's freezing threshold.
     - Deleting a canister.
 
-You can learn more about the developer journey and get started with level 0 in the [tutorials section of our developer documentation](/docs/current/tutorials/developer-journey/).
+You can learn more about the developer ladder and get started with level 0 in the [tutorials section of our developer documentation](/docs/current/tutorials/developer-journey/).
 
 ## Ethereum starter project
 

diff --git a/blog/news-and-updates/2023-09-13-update.mdx b/blog/news-and-updates/2023-09-13-update.mdx
@@ -41,9 +41,9 @@ Want to get started? The interactive tutorial can be found in our Motoko documen
 
 Over the past few weeks, we've had some great new pages added to our developer documentation. Let's take a look at some of the new additions!
 
-- [Developer journey level 0](/docs/current/tutorials/developer-journey/level-0/): Start your developer journey at the very beginning by following the level 0 module. In level 0, we cover the fundamentals of what the Internet Computer is, what terms you should be familiar with, and what tools we'll be using throughout our journey.
+- [Developer ladder level 0](/docs/current/tutorials/developer-journey/level-0/): Start the developer ladder at the very beginning by following the level 0 module. In level 0, we cover the fundamentals of what the Internet Computer is, what terms you should be familiar with, and what tools we'll be using throughout our journey.
 
-- [Developer journey level 1](/docs/current/tutorials/developer-journey/level-1/): In the next stage of the developer journey, become a space cadet by getting comfortable creating your first dapp, managing your canisters, and acquiring and using cycles.
+- [Developer ladder level 1](/docs/current/tutorials/developer-journey/level-1/): In the next stage of the developer ladder, become a space cadet by getting comfortable creating your first dapp, managing your canisters, and acquiring and using cycles.
 
 - [Pulling canister dependencies](/docs/current/developer-docs/smart-contracts/maintain/import): Learn how to use the new `dfx deps` feature to pull third-party canister dependencies.
 

diff --git a/blog/news-and-updates/2023-09-27-update.mdx b/blog/news-and-updates/2023-09-27-update.mdx
@@ -1,6 +1,6 @@
 ---
 title: Developer weekly update September 27, 2023
-description: This week, we're going to talk all things new documentation, including level 2 of the developer journey series, plus the new workflow for requesting a cycles coupon.
+description: This week, we're going to talk all things new documentation, including level 2 of the developer ladder series, plus the new workflow for requesting a cycles coupon.
 tags: [Devs]
 image: /img/blog/dev-update-blog-sept-27.jpg
 ---
@@ -9,11 +9,11 @@ image: /img/blog/dev-update-blog-sept-27.jpg
 
 ![September 27 2023](../../static/img/blog/dev-update-blog-sept-27.jpg)
 
-Hello ICP developers and welcome to this edition of developer weekly! This week, we're going to talk all things new documentation, including level 2 of the developer journey series, plus the new workflow for requesting a cycles coupon. Let's get into it!
+Hello ICP developers and welcome to this edition of developer weekly! This week, we're going to talk all things new documentation, including level 2 of the developer ladder series, plus the new workflow for requesting a cycles coupon. Let's get into it!
 
-## Developer journey level 2
+## Developer ladder level 2
 
-This week, level 2 of the developer journey series was published. To recap, the developer journey is a new tutorial series that acts as the map for a developer to start or grow their journey as an ICP developer. In level 2, developers learn about canister upgrades, storage, data persistence, advanced canister calls, Candid, unit testing, and using third-party canisters. The full breakdown can be found below:
+This week, level 2 of the developer ladder series was published. To recap, the developer ladder is a new tutorial series that acts as the map for a developer to start or grow their journey as an ICP developer. In level 2, developers learn about canister upgrades, storage, data persistence, advanced canister calls, Candid, unit testing, and using third-party canisters. The full breakdown can be found below:
 
 - [2.1: Canister upgrades, storage, and persistence.](/docs/current/tutorials/developer-journey/level-2/2.1-storage-persistence): When a canister's code needs to have changes made, the canister must be upgraded. This module covers:
     - Memory types and terms.
@@ -96,7 +96,7 @@ This week, level 2 of the developer journey series was published. To recap, the
         - Deploying the actors locally.
         - Interacting with multiple actors.
 
-Want to start at the beginning? You can get started with your developer journey [here](/docs/current/tutorials/developer-journey/).
+Want to start at the beginning? You can get started with the developer ladder [here](/docs/current/tutorials/developer-journey/).
 
 ## New cycles coupon workflow
 

diff --git a/blog/news-and-updates/2023-10-18-update.mdx b/blog/news-and-updates/2023-10-18-update.mdx
@@ -1,6 +1,6 @@
 ---
 title: Developer weekly update October 18, 2023
-description: This week, we'll take a look at a new AI tool on the developer documentation, the latest level of the developer journey series, and ask for your feedback on naming a new tool!
+description: This week, we'll take a look at a new AI tool on the developer documentation, the latest level of the developer ladder series, and ask for your feedback on naming a new tool!
 tags: [Devs]
 image: /img/blog/dev-update-blog-oct-18.jpg
 ---
@@ -9,7 +9,7 @@ image: /img/blog/dev-update-blog-oct-18.jpg
 
 ![October 18 2023](../../static/img/blog/dev-update-blog-oct-18.jpg)
 
-This week, we'll take a look at a new AI tool on the developer documentation, the latest level of the developer journey series, and ask for your feedback on naming a new tool!
+This week, we'll take a look at a new AI tool on the developer documentation, the latest level of the developer ladder series, and ask for your feedback on naming a new tool!
 
 ## Developer docs 'Ask AI' chat bot
 
@@ -23,9 +23,9 @@ An example question might be, "What is ckBTC?", in which, the AI replies with a
 
 Try it yourself on the [developer docs](https://internetcomputer.org/docs/current/developer-docs/) by clicking the 'Ask AI' button!
 
-## Developer journey level 3
+## Developer ladder level 3
 
-Level 3 of the [developer journey tutorial series](/docs/current/tutorials/developer-journey/) is now live on the developer docs! In level 3, we cover Motoko package managers, HTTPS outcalls, certified data, agents, and Internet Identity. A full breakdown can be found below:
+Level 3 of the [developer ladder tutorial series](/docs/current/tutorials/developer-journey/) is now live on the developer docs! In level 3, we cover Motoko package managers, HTTPS outcalls, certified data, agents, and Internet Identity. A full breakdown can be found below:
 
 # Level 3: Space engineer
 

diff --git a/blog/news-and-updates/2023-10-25-update.mdx b/blog/news-and-updates/2023-10-25-update.mdx
@@ -1,6 +1,6 @@
 ---
 title: Developer weekly update October 25, 2023
-description: This week, we're excited to share the first video tutorial in the developer journey series, announce the name for the dfx version manager, and take a look at the details of a proposed new workflow for SNS launches. 
+description: This week, we're excited to share the first video tutorial in the developer ladder series, announce the name for the dfx version manager, and take a look at the details of a proposed new workflow for SNS launches.
 tags: [Devs]
 image: /img/blog/dev-update-blog-oct-25.jpg
 ---
@@ -9,19 +9,19 @@ image: /img/blog/dev-update-blog-oct-25.jpg
 
 ![October 25 2023](../../static/img/blog/dev-update-blog-oct-25.jpg)
 
-Hello developers and welcome back to developer weekly! This week, we're excited to share the first video tutorial in the developer journey series, announce the name for the `dfx` version manager, and take a look at the details of a proposed new workflow for SNS launches. 
+Hello developers and welcome back to developer weekly! This week, we're excited to share the first video tutorial in the developer ladder series, announce the name for the `dfx` version manager, and take a look at the details of a proposed new workflow for SNS launches.
 
-## Developer journey video series 
+## Developer ladder video series
 
-In previous dev updates, we've introduced the developer journey documentation series and provided updates when new 'levels' of the tutorial series have been published. In today's update, we're excited to share that the first video corresponding to the documentation has been released! 
+In previous dev updates, we've introduced the developer ladder documentation series and provided updates when new 'levels' of the tutorial series have been published. In today's update, we're excited to share that the first video corresponding to the documentation has been released!
 
-The first video, **ICP Developer Journey 0.1 | Overview of the Internet Computer** corresponds to the very first page in the developer journey series, which can be found [here](/docs/current/tutorials/developer-journey/level-0/ic-overview). 
+The first video, **ICP Developer Ladder 0.1 | Overview of the Internet Computer** corresponds to the very first page in the developer ladder series, which can be found [here](/docs/current/tutorials/developer-journey/level-0/ic-overview).
 
-New videos will be released every week, and will follow each page of the developer journey documentation - that means there will be a total of 36 videos! 
+New videos will be released every week, and will follow each page of the developer ladder documentation - that means there will be a total of 36 videos!
 
 The first video can be found on the DFINITY Youtube channel:
 
-[![ICP Developer Journey 0.1 | Overview of the Internet Computer](https://img.youtube.com/vi/oBUpJ4CqmN0/0.jpg)](https://youtu.be/oBUpJ4CqmN0?si=q5r223tFnWoZTMGz)
+[![ICP Developer Ladder 0.1 | Overview of the Internet Computer](https://img.youtube.com/vi/oBUpJ4CqmN0/0.jpg)](https://youtu.be/oBUpJ4CqmN0?si=q5r223tFnWoZTMGz)
 
 ## `dfx` version manager name decision