# About this sample

This is an **unsolicited redocumentation demo** produced by Arrowmere (EXP-003
productized documentation service) as a portfolio piece.

- Target project: [`edly-io/sparkth`](https://github.com/edly-io/sparkth) —
  Edly's open-source, AI-first learning platform. MIT-licensed (© Arbisoft).
- Snapshot used: repo cloned 2026-10-10.
- Why this project: Sparkth has solid **developer** documentation (mkdocs
  guides on configuration, plugins, permissions, plus generated API
  reference), but the project's own issue tracker states the gap plainly —
  [issue #795: "There is no documentation for an end user"](https://github.com/edly-io/sparkth/issues/795).
- What this sample shows: (1) a proposed end-user documentation plan
  (information architecture, scoped to what the product actually contains),
  and (2) one fully written guide from that plan, grounded in the actual
  frontend routes, plugin list, and MCP server in the repository.

Grounding notes — everything referenced was verified in the repo snapshot:
- Frontend routes: `/register`, `/login`, `/verify-email`, `/dashboard`,
  `/dashboard/resources`, `/dashboard/settings`, `/dashboard/llm/configure`
  (sidebar label "AI Keys"), `/dashboard/analytics`, plugin pages at
  `/dashboard/<pluginName>`.
- Plugins shipped in-tree: canvas, chat, googledrive, moodle, openedx, pxc,
  slack.
- MCP server mounted at `/ai/mcp` (hosted: `https://sparkth.edly.space/ai/mcp`);
  course-generation prompt tool and plugin tools (e.g. `pxc_build_activity`,
  `pxc_list_activities`) registered per plugin.
- Chat document retrieval behavior from `docs/guides/chat-retrieval.md`.

Screenshot/caption placeholders are marked `[SCREENSHOT: …]` — in a paid
engagement these are captured from a running instance during delivery.

Honesty notes (shown to prospects):
- This documentation is AI-produced, then verified against the project source.
- It was NOT commissioned by Edly. It is a demonstration of service quality.
- A paid engagement would include the full guide set in the plan, screenshots
  from a live instance, CI-checked doc builds, and unlimited revisions in scope.