Redesign Scope documentation with an interactive benchmark playground - #1400
Wassim Chegham (manekinekko) wants to merge 6 commits into
Conversation
Refresh the landing page and guide navigation, add a five-agent simulated flow, and preserve static GitHub Pages routes and accessibility. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 Changes recommended
The new playground has an accessibility labeling mismatch and a runtime error path that should be corrected before merging.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR refreshes the Astro + Starlight documentation site with a redesigned landing experience and an interactive “benchmark playground”, while also fixing GitHub Pages base-path routing and updating documentation links/copy to match the new structure.
Changes:
- Replace the previous MDX splash homepage with an Astro-driven landing page that includes a progressive-enhancement playground (custom element controller + static HTML fallback).
- Add a Markdown/MDX remark plugin to safely prefix root-relative links under the GitHub Pages project base, and update site config/workflow to build static output correctly on PRs vs
main. - Fix/refresh documentation copy and links (notably REST API reference paths) and update website contributor/deployment notes.
File summaries
| File | Description |
|---|---|
| website/src/styles/landing.css | Replaces landing styling with new shared tokens + homepage/playground layout styles. |
| website/src/scripts/sample-agents.ts | Adds a shared illustrative agent roster used by the playground. |
| website/src/scripts/flow-demo.ts | Adds the custom element controller for the interactive playground (progressive enhancement). |
| website/src/plugins/remark-base-links.mjs | Adds a remark transform to prefix root-relative links with the Pages base path. |
| website/src/content/docs/resources/glossary.md | Updates glossary terminology/copy (criteria DAG wording, fixes stray text). |
| website/src/content/docs/resources/faq.md | Fixes REST API reference link target. |
| website/src/content/docs/reference/rest-api.md | Fixes REST API reference link target(s). |
| website/src/content/docs/index.mdx | Swaps the splash page markup to use the new Home Astro component. |
| website/src/content/docs/guides/submitting-requests-api.mdx | Updates REST API reference link target(s). |
| website/src/content/docs/guides/prioritizing-requests.mdx | Updates REST API reference link target(s). |
| website/src/content/docs/getting-started/install-cli.md | Fixes SCOPE_INSTALL_DIR usage so it applies to the installer process. |
| website/src/components/SiteTitle.astro | Simplifies logo styling (removes animated wave; adjusts sizing). |
| website/src/components/PageTitle.astro | Adds a homepage-only title override hook for Starlight layouts. |
| website/src/components/Home.astro | New Astro homepage component (landing sections, onboarding paths, base-aware links). |
| website/src/components/Header.astro | New homepage-specific header/nav composition (uses Starlight search + theme select). |
| website/src/components/FlowDemo.astro | New static playground markup (buttons, wiring SVG, aria-live announcements, noscript fallback). |
| website/README.md | Documents the redesign, local build/deploy behavior, and playground intent/constraints. |
| website/astro.config.mjs | Adds static output, remark-base-links plugin, new component overrides, and sidebar reorg. |
| website/.gitignore | Ignores Astro build artifact directory. |
| .github/workflows/static.yml | Adjusts build env so PRs build with /scope base while main uses Pages base path. |
Review details
- Files reviewed: 20/20 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Looks really good and directionally clearly what we want. A few things to think about: Scope playground screen
The less searching, more building is really great! |
|
Implemented all your suggestions Cedric Vidal (@cedricvidal) ;) |
Show supported and planned agents, compare base and alternate profiles, explain gates and reusable criteria, and surface simulated token and duration metrics. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Looks really good! A few more remarks:
|
|
Copilot resolve the merge conflicts in this pull request |
…umentation-redesign # Conflicts: # .github/workflows/static.yml # website/README.md # website/astro.config.mjs Co-authored-by: manekinekko <1699357+manekinekko@users.noreply.github.com>
Merged |
Keep one task-board example, label the walkthrough and playback as mock data, and derive result previews from the shared fixture. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Pushed all pending website changes in 03b8813 and replaced the old video in the PR description with a new 75-second recording of the current UI.
Local checks passed: eight example-data tests, seven website-plugin tests, strict TypeScript checks, and the 200-page production build with the GitHub's build, gitleaks, and CLA checks passed for this commit. Deployment is intentionally skipped for pull requests. The working tree is clean. |
Website walkthrough
A fresh, captioned 75-second tour of the single task-board example. It shows the explicit mock-data labels, supported and planned agents, a base profile with two alternate profiles, evaluation gates and a reusable criteria library, the expandable criteria graph, token counts and duration differences, animation playback, and dark mode. No live agents run in this example; all outcomes and metrics are invented.
scope-interactive-example-2026-09-21.mp4
Summary
Refresh the Astro + Starlight documentation website with a clearer landing page, task-oriented navigation, and an interactive benchmark example.
website/README.md.Reviewer focus
Explore the homepage, play and pause the animation, inspect each step, compare the profile variations, and expand the criteria graph and per-criterion results. The walkthrough uses one fixed task-board example, not scenario switching. Availability badges distinguish supported agents from planned or unavailable integrations. All outcomes, token counts, and durations are illustrative, not benchmark measurements or agent rankings.
GitHub Pages stays static. PR builds use
/scope; deployment remains restricted tomain.Validation
/scope/, preserving 200 pages.03b88131; deployment is intentionally skipped for pull requests.