Repository navigation
Clarify product and security docs with focused navigation and visuals - #24
Merged
Merged
Conversation
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.
The docs mixed product tasks with SDK setup, overused sidebar icons, and left security controls buried in a short overview. The navigation now uses icons only for product destinations, keeps release and identity setup under SDK configuration, and places the API item under Developer tools with the label “API”.
Surfaces has a product-focused Releases guide. Security now has dedicated identity-provider, SSO, SCIM directory-sync, verified-domain, network-access, and published-IP-range pages. Verified domains live under Security and explain verification and enrollment. Correct the previous claim that activating SSO disables email codes and passkeys; the current settings flow retains them.
Add seven Mermaid diagrams for product evidence, releases, authentication, provisioning, domain verification, and network decisions. Add availability and warning callouts plus a focused surface Events screenshot. Diagram controls sit above the graphic so they do not cover labels and remain usable on mobile. This follows Cloudflare's visual guidance.
Network allowlisting is already Enterprise-only in the product: Stripe grants
network-accessonly to Enterprise, the API rejects nonempty rule writes without a current entitlement, and the UI hides editors. No application behavior change is needed. The docs now make the restriction explicit and describe downgrade recovery without confusing workspace allowlisting with the public IP address feed.Validation:
Product tests ran in the dependency-equipped application checkout after confirming the network gating and browser test files match the working checkout. Authoring instructions record the product/SDK boundary, icon rules, and visual conventions.