docs: restructure and rewrite for current AskUI product#6
Open
philipph-askui wants to merge 7 commits into
Open
docs: restructure and rewrite for current AskUI product#6philipph-askui wants to merge 7 commits into
philipph-askui wants to merge 7 commits into
Conversation
- Add prominent quickstart guide (< 10 min: register, install, first run) - Rewrite home page with product overview, how it works, and why AskUI - Remove all Python/legacy SDK references from main docs; add Legacy section for Python SDK and TypeScript SDK with migration guidance - Correct CLI and AgentOS install story: CLI ships with Desktop installer, standalone AgentOS installer coming soon, no Python runtime (pure C#) - Restructure AgentOS nav: rename "How-to guides" to "Deployment" section, elevate Troubleshooting to top-level AgentOS page - Add CI examples page (GitHub Actions, GitLab CI, Azure DevOps) - Add Support section: FAQ, Get help (with diagnostic tool callout), index - Add Reference pages: environment variables, network requirements, glossary - Remove internal-only workspace API and inference API pages - Add Account & Billing pages: members (roles/invite), usage dashboard - Add uninstall guide (Windows + macOS) - Mark OpenAI-compatible BYOM providers as experimental with no support - Remove Discord links throughout; remove all scaffold placeholder notes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove the secrets/ folder from all scaffold/structure lists (quickstart, first-run, project-structure, glossary) since the app no longer scaffolds it - Reword credentials guidance to a generic local credentials file instead of secrets/credentials.txt - Rework the landing page hero: new breadth-led headline and subhead, larger type, and a subtle brand-tinted glow Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Split monolithic FAQ into subpages under faq/ (General, Getting started, Technical, Runs & reports, Pricing & licensing, Use cases) - Move troubleshooting-oriented FAQ content into troubleshooting.mdx: new sections for Connection & session issues, Agent behavior, and Performance & cost - Move troubleshooting.mdx from agentos/ to support/; update all inbound links across service.mdx, get-help.mdx, environment-variables, network-requirements, and support/index - Absorb IT firewall and admin-rights questions into FAQ Technical page - FAQ index now points to Troubleshooting for error/symptom queries Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Move prompting-best-practices and system-prompt from using-askui-desktop/ to guides/ - Add new writing-tests guide - Refactor guides into three focused pages: what-goes-where, system-prompt quality, test quality - Shorten agents-and-prompts.mdx to show only real defaults, cross-reference guides - Update all inbound links across quickstart, first-run, project-structure, troubleshooting Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- run-report: add full coverage of markdown reports, summary report, and HTML report; demote live run viewer to a brief section - agents-and-prompts: clarify scratchpad use case, rename per-folder to per-suite, use suite terminology consistently - project-structure: tighten description, note subsuites as subfolders - model-providers: remove trailing Next cards section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- guides/index: convert Coming soon bullet list to Cards - guides/system-prompt: soften error-discipline framing, add naming conventions bullet to UI information, retitle report format section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Create content/docs/troubleshooting/ with index + 8 subpages: connection-sessions, agent-behavior, performance-cost, agentos-service, proxy-ssl, run-failures, model-providers, licensing - Add troubleshooting to top-level meta.json nav - Remove troubleshooting from support/meta.json and delete the old support/troubleshooting.mdx - Update all inbound links across faq/, support/, agentos/, reference/ Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
2 participants
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