docs: cover the ii-app-metadata well-known file in the II guide - #347
Draft
aterga wants to merge 1 commit into
Draft
docs: cover the ii-app-metadata well-known file in the II guide#347aterga wants to merge 1 commit into
aterga wants to merge 1 commit into
Conversation
Apps can now provide their own name, description, and logo for the Internet Identity sign-in screens by serving /.well-known/ii-app-metadata on the origin their identities are derived for, replacing the curated list that used to be the only way to get branded. Nothing in the guide covered it. The new section sits between Alternative origins and Common mistakes, which is where it belongs: it reuses the derivation origin the reader has just configured, and extends the same .ic-assets.json5 with CORS entries for the document and the logo. It carries the limits an integrator has to respect (field lengths, the raster-only logo rules, the document cap), the fact that one invalid field drops the whole document and why the browser console is the place to look, and the reminder that this metadata proves nothing about an app's identity, which is why the origin stays on screen next to it.
|
🤖 Here's your preview: https://mmsik-fiaaa-aaaam-ahq7a-cai.icp0.io |
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.
Summary
docs/guides/authentication/internet-identity.mdx, between Alternative origins and Common mistakes, covering the/.well-known/ii-app-metadatadocument that lets an app supply its own name, description, and logo for the Internet Identity sign-in screens. Nothing in the guide covered it: until now the only way to get branded screens was to be in the curated list shipped inside II, which this mechanism replaces..ic-assets.json5with CORS entries for the document and the logo.200with no redirect, and the 10 second budget. It also states that a single invalid field drops the whole document and that II names the offending field in the browser console, since that is the first thing someone debugging missing metadata needs to know.Structural decisions
##section so it sits as a sibling of Alternative origins and Common mistakes rather than nesting under either. The mechanism is independent of alternative origins: apps that never set aderivationOriginuse it too.../../references/internet-identity-spec.mdrather than upstream GitHub. Worth knowing when sequencing this: that mirrored page does not carry the app metadata section yet, because.sources/internetidentityis pinned to a commit older than the upstream change (feat(fe): permissionless app metadata for the authorize flow internet-identity#4221, merged asf5b84b2). Bumping that submodule and runningnpm run sync:ii-specpulls the section in, at which point the link can gain a#app-metadataanchor. That is a maintainer-scope submodule bump, so it is not part of this PR.Verification
node scripts/validate.js --all: no errors in the changed file. The 4 reported errors are pre-existing, indocs/guides/digital-assets/chain-key-tokens.mdxanddocs/guides/backends/data-persistence.mdx, both untouched here.@mdx-js/mdxagainst the file body).npm run buildwas not run locally:.sources/submodules are uninitialized in this environment and most are SSH remotes, so a build fails on unrelated pages that resolve snippets from them. CI'sbuild_and_deploycovers it and is green, and the preview was checked in the browser: heading order is Local development → Alternative origins → App metadata → Common mistakes → Next steps, both JSON blocks render, and the spec link resolves.:::notein the new section renders as a plaindivrather than a styled callout. So does the page's pre-existing note under Alternative origins: the built page contains nostarlight-asideelements at all, so this is existing site behaviour and not something this change introduces. Left as is to match the page; happy to open a separate issue if the directive handling should be fixed.src/frontend/src/lib/utils/appMetadata.tsin dfinity/internet-identity), not from memory.