Skip to content

docs: README refresh — 'controllable map for AI agents' lead + full-width video banner - #5

Merged
isConic merged 2 commits into
mainfrom
docs/readme-refresh
Aug 7, 2026
Merged

docs: README refresh — 'controllable map for AI agents' lead + full-width video banner#5
isConic merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@isConic

@isConic isConic commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

What

Refresh the README opening and replace the GIF banner with a full-width video.

  • New lead copy centered on "MapControl is a controllable map for AI agents" — what agents can do on the map, the three control interfaces (MCP / Python / REST) operating on the same live sessions, and the ask-an-agent example.
  • Banner: GIF → video. docs/output2.gif (10 MB) rendered at its fixed intrinsic size and fit the page poorly. A GitHub-hosted video attachment renders as a native player spanning the full README content width, with play/pause/scrub.

⏳ One step left before merge

GitHub video attachments can only be created through the web UI. To finish:

  1. Drag zermatt-banner.mp4 (the compressed 7.9 MB demo) into a comment box on this PR (don't post it — just grab the URL it inserts).
  2. Replace the <!-- VIDEO-BANNER: ... --> placeholder line in README.md on this branch with that bare https://github.com/user-attachments/assets/... URL on its own line.
  3. Confirm the video player renders in the branch README preview, then merge.

Notes

  • No functional changes — docs only. (Merge will trigger the publish workflow; harmless/idempotent.)

…'; swap GIF banner for video placeholder

- New lead: what agents can do with the map, the three control
  interfaces (MCP / Python / REST) operating on the same live
  sessions, and the ask-an-agent example.
- Drop docs/output2.gif (10 MB, rendered at fixed intrinsic size and
  fit poorly); the banner becomes a GitHub-hosted video attachment,
  which renders as a full-content-width player. Placeholder comment
  marks where the user-attachments URL goes (added on the PR).
@isConic

isConic commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author
zermatt-banner.mp4

@isConic
isConic merged commit b2dd8dc into main Aug 7, 2026
3 checks passed
@isConic
isConic deleted the docs/readme-refresh branch August 7, 2026 16:28
emirkaan5 pushed a commit to emirkaan5/mc2 that referenced this pull request Aug 7, 2026
…idth video banner (ESIPFed#5)

* docs: rewrite README opening around 'a controllable map for AI agents'; swap GIF banner for video placeholder

- New lead: what agents can do with the map, the three control
  interfaces (MCP / Python / REST) operating on the same live
  sessions, and the ask-an-agent example.
- Drop docs/output2.gif (10 MB, rendered at fixed intrinsic size and
  fit poorly); the banner becomes a GitHub-hosted video attachment,
  which renders as a full-content-width player. Placeholder comment
  marks where the user-attachments URL goes (added on the PR).

* docs: set the video banner to the uploaded demo attachment

---------

Co-authored-by: Otto Wagner <otto.wagner@ama-inc.com>
isConic pushed a commit to emirkaan5/mc2 that referenced this pull request Aug 7, 2026
Both artifacts of syncing the fork's main with upstream: the gif was
deleted upstream in ESIPFed#5 (nothing references it), and _internal_base_url()
already landed upstream in 2e1bb00 — the merge kept both copies.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants