feat(KNO-13285): final preference center docs#1528
Draft
andy-knock wants to merge 2 commits into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
3 tasks
Contributor
Author
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
andy-knock
force-pushed
the
preference-center-final
branch
from
b181cc4 to
06ee119
Compare
andy-knock
changed the title
andy-knock
force-pushed
the
preference-center-final
branch
2 times, most recently
from
8e22222 to
1171a36
Compare
andy-knock
force-pushed
the
preference-center-final
branch
from
80d28c0 to
fcc1571
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
from
d74f371 to
2701ed1
Compare
andy-knock
force-pushed
the
preference-center-final
branch
2 times, most recently
from
8ddc056 to
13855f5
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
2 times, most recently
from
bea9a56 to
65365c2
Compare
andy-knock
force-pushed
the
preference-center-final
branch
2 times, most recently
from
4cddb54 to
7ef31ff
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
from
65365c2 to
862a7f7
Compare
andy-knock
force-pushed
the
preference-center-final
branch
from
7ef31ff to
cda82a4
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
from
693605b to
7ce60df
Compare
andy-knock
force-pushed
the
preference-center-final
branch
2 times, most recently
from
8fb31c7 to
cdb8faf
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
from
c2b559b to
b8774fa
Compare
Replace TODO placeholders with API docs aligned to switchboard #6885:
GET /v1/users/{user_id}/preference_center/config (public key + user token)
and POST /v1/users/{user_id}/preference_center/signed_url (secret key).
Update OpenAPI and stainless specs; remove deprecated PC-token endpoints.
andy-knock
force-pushed
the
preference-center-final
branch
from
cdb8faf to
8718fdd
Compare
andy-knock
force-pushed
the
preference-api-auth
branch
from
b8774fa to
bee9c58
Compare
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
1 participant
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
Restructures preference center documentation into two clear paths (hosted vs build-your-own) with a decision guide on the overview, a standalone build page, and React tutorials reframed as implementation examples.
Changes
Information architecture
preferences/overview.mdx— Replaces the inline build tutorial with Choosing a preference center (comparison table + decision questions linking to hosted and build paths).preferences/build-your-preference-center.mdx(new) — Standalone walkthrough: auth, four-step flow, client SDK examples, optional dashboard-managed config section, implementation SdkCards.preferences/hosted-preference-center.mdx— Intro bullets, split linking (workflow templates vs backend signed URL), cross-links to decision guide and build page.data/sidebars/platformSidebar.ts— Adds build page to Preferences sidebar.React tutorials reframed
in-app-ui/react/preferences.mdxandin-app-ui/react/headless/preferences.mdx— Positioned as React-specific implementations of build-your-own; callout links updated.Cross-links
#create-a-default-preferencesetanchors.Stack
Stacked on #1526 (auth + public-key clarifications). Merge the full stack via Graphite.
Follow-up TODOs (blocked on backend)
Architecture finalized in switchboard #6885 (KNO-13285). Doc TODOs in this PR reference the intended API surface:
POST /v1/users/{user_id}/preference_center/signed_url(secret key →{ url, token }) on hosted page; link to API reference once spec is current.GET /v1/users/{user_id}/preference_center/config(public key + user token → dashboard row config) on build page; add client examples.data/specs/api/openapi.ymlwhen #6885 merges (config moves off/v1/preference_center/config; duplicate PC-token preference endpoints removed)./v1/preference_center/preferencesendpoints — build-your-own read/write stays on standardpreferences.get()/preferences.set().Test plan