docs: improve IA for automation developers — surface Quick Start Guide#9
Open
ekline[bot] wants to merge 2 commits into
Open
docs: improve IA for automation developers — surface Quick Start Guide#9ekline[bot] wants to merge 2 commits into
ekline[bot] wants to merge 2 commits into
Conversation
…m onboarding page
The Flows Quick Start Guide was buried below 40+ reference pages in the
sidebar, making it invisible to new users. The main onboarding page
("Your First Automation") linked only to UCL tutorials, not the Quick
Start. This reorders the sidebar and adds a prominent Quick Start link
on the onboarding page so automation developers find the starting point
immediately.
…velopers "Embedding UCL onto your AI Agent" was nested 3 levels deep under the conceptual "About Unified Context Layer" section. AI developers looking for implementation steps had to click through conceptual content first. This promotes the embedding guide to sit directly under "Getting Started" in the UCL section, and adds a prominent callout on the UCL landing page linking to it.
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.
Persona context
This PR addresses findings from a persona-scoped information architecture review of the Fastn documentation. Three personas were evaluated:
Top 3 findings
SUMMARY.md,your-first-automation.mdSUMMARY.md, UCL Getting Started pageembedded-integrations/README.mdWhat this PR fixes
Finding #1 — Quick Start Guide discoverability (Automation Developer)
SUMMARY.md: Moved "Quick Start Guide" from below "Flow Setup Essentials" (position 75 in sidebar) to the first item under the Flows sectionyour-first-automation.md: Restructured the onboarding page into three clear paths with the Quick Start Guide as the most prominent entry pointFinding #2 — UCL embedding guide visibility (AI Developer)
SUMMARY.md: Promoted "Embedding UCL onto your AI Agent" from 3 levels deep (under "About Unified Context Layer") to a direct child of "Getting Started" — now the first item AI developers see when they expand the UCL sectionucl-unified-context-layer/getting-started/README.md: Added a prominent success callout at the top of the UCL landing page linking directly to the embedding guideRemaining items (follow-up work)
How to verify