docs: developer onboarding pass for all entry-point READMEs - #1466
Open
marc0olo wants to merge 2 commits into
Open
docs: developer onboarding pass for all entry-point READMEs#1466marc0olo wants to merge 2 commits into
marc0olo wants to merge 2 commits into
Conversation
Every category directory now has a proper entry point focused on getting a newcomer from zero to a running example: - Root README: contribution invitation removed (repo is not soliciting external PRs while examples are restructured for the developer docs), 'New here?' path rewritten with language-labeled links (hello_world → who_am_i), wasm/ listed alongside the other categories. - motoko/ and hosting/ READMEs rewritten; rust/, native-apps/, and wasm/ READMEs created: each opens with a start-here path, then a categorized index of every example with a one-line description and relative links, and closes with the canonical security-best-practices link. - vetkeys indexes: motoko/vetkeys/README.md created; rust/vetkeys/README.md rewritten to link the local examples instead of the upstream vetkeys repository (which it pointed at exclusively, under partly wrong names). - Link conventions applied throughout: Internet Identity mentions link the developer docs guide in integration contexts (id.ai stays only for live-instance references, e.g. ic-pos mainnet notes); all external links verified against the current docs site; all relative links checked. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… canister The hosting examples run on the @dfinity/static-site recipe (certified-assets canister), which replaces the legacy asset canister going forward. Name both, state the direction, and mark photo-storage as the deliberate legacy exception (AssetManager uploads). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Improves developer onboarding by adding and standardizing entry-point READMEs across the repository’s top-level example categories, ensuring newcomers have consistent “start here” guidance and complete indexes with verified links.
Changes:
- Updated the root
README.md“New here?” path and expanded category directory listing (includingwasm/). - Added new entry-point READMEs for previously undocumented categories (
rust/,native-apps/,wasm/) and rewrote existing category READMEs (motoko/,hosting/) into a consistent structure. - Added/rewrote vetKeys index READMEs so the repo’s local vetKeys examples are discoverable and cross-linked between Motoko and Rust.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Refines the newcomer path and updates top-level category navigation (adds wasm/). |
| hosting/README.md | Replaces outdated/partial index with a complete, structured hosting category entry point. |
| motoko/README.md | Expands Motoko category entry point with a guided start path and full categorized index. |
| motoko/ic-pos/README.md | Updates Internet Identity link to the current docs guide. |
| motoko/vetkeys/README.md | Adds a Motoko vetKeys index with cross-links and categorized example list. |
| native-apps/README.md | Creates a native-apps entry point with a short index and consistent security footer. |
| native-apps/unity_ii_deeplink/README.md | Updates Internet Identity link to the current docs guide. |
| rust/README.md | Creates a Rust category entry point with start-here guidance and categorized index. |
| rust/vetkeys/README.md | Rewrites vetKeys index to point to local examples (and Motoko counterparts) instead of upstream-only links. |
| wasm/README.md | Creates a wasm category entry point describing low-level canister examples and indexing counter/. |
Comments suppressed due to low confidence (1)
hosting/README.md:15
- This parenthetical says
photo-storageruns on the legacy asset canister, buthosting/photo-storage/icp.yamluses the@dfinity/static-siterecipe. The description here should match the repo’s actual configuration.
- [`photo-storage`](photo-storage/) — store and manage photos programmatically with `AssetManager` from `@icp-sdk/canisters/assets` (runs on the legacy asset canister).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marc0olo
marked this pull request as ready for review
July 30, 2026 13:52
mraszyk
approved these changes
Jul 30, 2026
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
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.
Every category directory now has a real entry point for newcomers. Before this PR:
motoko/README.mdwas three lines with a dead security URL,hosting/README.mdlisted 3 of 6 examples via absolute GitHub URLs, andrust/,native-apps/,wasm/had no README at all.Root README
hello_world([Motoko] or [Rust]) →who_am_ifor Internet Identity.wasm/listed alongside the other category directories.Category entry points
motoko/andhosting/rewritten;rust/,native-apps/,wasm/created. Consistent shape: what the directory is → start-here path → categorized index (every example, one-line description, relative links) → security-best-practices footer. Categories: getting started / full-stack apps / tokens & payments / chain fusion & signing / HTTPS outcalls / inter-canister patterns / system features / compute & AI / vetKeys.vetkeys indexes
motoko/vetkeys/README.mdcreated (there was none).rust/vetkeys/README.mdrewritten: it previously linked only to the upstream dfinity/vetkeys repo (one under a name that doesn't match the local directory), steering readers away from the code next to it.Link conventions
docs.internetcomputer.org/guides/authentication/internet-identity) in integration contexts;id.aikept only for live-instance references (ic-pos mainnet section, unity deep-link endpoint). Applied to root, ic-pos, unity_ii_deeplink, and the new entry points.🤖 Generated with Claude Code