codex-context-map 0.1.0 → 0.1.1

package/README.md

@@ -8,6 +8,8 @@ An offline visual debugger for `AGENTS.md` discovery, overrides, and byte limits
 
 [Live demo](https://han-1413141.github.io/codex-context-map/) · [简体中文](README.zh-CN.md) · [How it works](docs/semantics.md) · [Releases](https://github.com/Han-1413141/codex-context-map/releases)
 
+[Share kit: demo links, screenshots and introductions](docs/share-kit.md)
+
 [![CI](https://github.com/Han-1413141/codex-context-map/actions/workflows/ci.yml/badge.svg)](https://github.com/Han-1413141/codex-context-map/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/codex-context-map)](https://www.npmjs.com/package/codex-context-map)
 ![Node](https://img.shields.io/badge/node-%3E%3D20-087f6b)
@@ -25,6 +27,10 @@ You added an instruction. Codex still behaves differently. Is the file outside t
 
 Open the **[interactive demo](https://han-1413141.github.io/codex-context-map/)** and click **Hidden override**, **Budget cutoff**, or **Empty override**. You can also open a project folder: the page processes instruction files on your device.
 
+Jump straight to an example: **[Hidden override](https://han-1413141.github.io/codex-context-map/?scenario=override&lang=en)** · **[Budget cutoff](https://han-1413141.github.io/codex-context-map/?scenario=budget&lang=en)** · **[Empty override](https://han-1413141.github.io/codex-context-map/?scenario=empty&lang=en)**. Each preset has a share link containing only its fictional scenario and language.
+
+New to instruction discovery? Read **[Why is Codex ignoring my AGENTS.md?](https://han-1413141.github.io/codex-context-map/why-codex-ignores-agents-md.html)** for a worked example of directory boundaries, overrides and byte cutoffs.
+
 Or inspect your repository with Node.js 20+:
 
 ```bash

package/README.zh-CN.md

@@ -8,6 +8,8 @@
 
 [在线演示](https://han-1413141.github.io/codex-context-map/) · [English](README.md) · [解析规则](docs/semantics.md) · [下载版本](https://github.com/Han-1413141/codex-context-map/releases)
 
+[分享素材：场景链接、截图与中英文介绍](docs/share-kit.md)
+
 [![CI](https://github.com/Han-1413141/codex-context-map/actions/workflows/ci.yml/badge.svg)](https://github.com/Han-1413141/codex-context-map/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/codex-context-map)](https://www.npmjs.com/package/codex-context-map)
 [![MIT](https://img.shields.io/badge/License-MIT-087f6b.svg)](LICENSE)
@@ -24,6 +26,10 @@
 
 打开 **[在线演示](https://han-1413141.github.io/codex-context-map/)**，点击右上角「中文」，体验「隐藏的覆盖」「超出长度预算」「空覆盖文件」。也可以打开自己的项目文件夹，指令内容只在当前设备处理。
 
+也可以直接打开中文场景：**[隐藏覆盖](https://han-1413141.github.io/codex-context-map/?scenario=override&lang=zh)** · **[字节截断](https://han-1413141.github.io/codex-context-map/?scenario=budget&lang=zh)** · **[空覆盖文件](https://han-1413141.github.io/codex-context-map/?scenario=empty&lang=zh)**。场景的分享链接只包含虚构场景名称和语言。
+
+初次了解加载规则？阅读 **[Codex 为什么没有遵循 AGENTS.md？](https://han-1413141.github.io/codex-context-map/zh/why-codex-ignores-agents-md.html)**，通过完整示例检查目录边界、覆盖关系与字节截断。
+
 使用 Node.js 20+ 在仓库中运行：
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codex-context-map",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "See which AGENTS.md files Codex discovers, what overrides what, and where instructions get cut off. Offline CLI + interactive map.",
   "type": "module",
   "bin": {
@@ -13,7 +13,9 @@
   "files": [
     "bin",
     "src",
-    "site",
+    "site/app.js",
+    "site/style.css",
+    "site/template.html",
     "README.md",
     "README.zh-CN.md",
     "LICENSE"

package/site/app.js

@@ -20,6 +20,8 @@ let compareTarget =
 let view = "map";
 let language = "en";
 let result;
+const publicDemoUrl = "https://han-1413141.github.io/codex-context-map/";
+const presets = new Set(["override", "budget", "empty"]);
 const english = Object.fromEntries(
   [...document.querySelectorAll("[data-i18n]")].map((el) => [
     el.dataset.i18n,
@@ -50,6 +52,10 @@ const chinese = {
   scenarioOverride: "01 · 隐藏的覆盖",
   scenarioBudget: "02 · 超出长度预算",
   scenarioEmpty: "03 · 空覆盖文件",
+  openDemoLink: "打开此演示链接 ↗",
+  copyDemoLink: "复制链接",
+  shareHint: "仅分享此虚构演示场景。",
+  guide: "AGENTS.md 不生效？查看排障指南 ↗",
   loaded: "贡献内容的文件",
   loadedHint: "按发现顺序排列",
   shadowed: "被遮盖的文件",
@@ -103,6 +109,8 @@ function applyLanguage() {
         ? (chinese[el.dataset.i18n] ?? english[el.dataset.i18n])
         : english[el.dataset.i18n];
   $("language").textContent = language === "zh" ? "EN" : "中文";
+  $("guide-link").href =
+    `${publicDemoUrl}${language === "zh" ? "zh/" : ""}why-codex-ignores-agents-md.html`;
   $("search").placeholder = say("Find a directory…", "搜索目录…");
   $("search").setAttribute("aria-label", say("Find a directory", "搜索目录"));
   $("budget").setAttribute(
@@ -290,6 +298,16 @@ function render() {
     ? say("DEMO WORKSPACE", "演示项目")
     : say("LOCAL SNAPSHOT", "本地快照");
   $("scenarios").hidden = !isDemo;
+  const preset = currentPreset();
+  $("demo-share").hidden = !preset;
+  $("demo-link").href = preset
+    ? `${publicDemoUrl}?scenario=${preset}&lang=${language}`
+    : publicDemoUrl;
+  for (const button of document.querySelectorAll("[data-scenario]"))
+    button.setAttribute(
+      "aria-pressed",
+      String(button.dataset.scenario === preset),
+    );
   $("current-path").innerHTML =
     `<span style="color:var(--muted)">${esc(snapshot.projectName)}</span>${
       target === "."
@@ -327,6 +345,24 @@ function render() {
   renderPreview();
   if (view === "compare") renderComparison();
 }
+function currentPreset() {
+  if (!isDemo || view !== "map" || fallbackNames.join(",") !== "TEAM_GUIDE.md")
+    return null;
+  if (target === "tools/lab" && budget === DEFAULT_BUDGET) return "empty";
+  if (target === "services/payments") {
+    if (budget === 1024) return "budget";
+    if (budget === DEFAULT_BUDGET) return "override";
+  }
+  return null;
+}
+function selectPreset(preset) {
+  if (!isDemo || !presets.has(preset)) return;
+  target = preset === "empty" ? "tools/lab" : "services/payments";
+  budget = preset === "budget" ? 1024 : DEFAULT_BUDGET;
+  fallbackNames = [...createDemo().settings.fallbackNames];
+  $("search").value = "";
+  view = "map";
+}
 function loadSnapshot(input, demo = false) {
   const validated = validateSnapshot(input);
   snapshot = validated;
@@ -508,11 +544,26 @@ $("apply-fallbacks").addEventListener("click", () => {
 $("scenarios").addEventListener("click", (event) => {
   const scenario = event.target.closest("[data-scenario]")?.dataset.scenario;
   if (!scenario) return;
-  target = scenario === "empty" ? "tools/lab" : "services/payments";
-  budget = scenario === "budget" ? 1024 : DEFAULT_BUDGET;
-  view = "map";
+  selectPreset(scenario);
   render();
 });
+$("copy-demo-link").addEventListener("click", async () => {
+  if (!currentPreset()) return;
+  const url = $("demo-link").href;
+  try {
+    await navigator.clipboard.writeText(url);
+    announce(
+      say(
+        "Demo link copied. It contains only the fictional scenario and language.",
+        "演示链接已复制，仅包含虚构场景和语言。",
+      ),
+    );
+  } catch {
+    announce(
+      say(`Copy this demo link: ${url}`, `请手动复制此演示链接：${url}`),
+    );
+  }
+});
 $("map-view").addEventListener("click", () => {
   view = "map";
   render();
@@ -577,5 +628,8 @@ $("json-input").addEventListener("change", async (event) => {
     event.target.value = "";
   }
 });
+const incoming = new URLSearchParams(location.search);
+if (incoming.get("lang") === "zh") language = "zh";
+if (initialData.demo) selectPreset(incoming.get("scenario"));
 applyLanguage();
 render();

package/site/style.css

@@ -511,6 +511,25 @@ h2 {
   border-color: #89b9a6;
   background: var(--accent-soft);
 }
+.scenarios button[aria-pressed="true"] {
+  border-color: #478b72;
+  color: #24694e;
+  background: var(--accent-soft);
+}
+.demo-share {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  gap: 12px;
+  margin: -7px 0 20px;
+  font-size: 11px;
+}
+.demo-share a {
+  color: #24694e;
+}
+.demo-share span {
+  color: var(--muted);
+}
 .metrics {
   display: grid;
   grid-template-columns: 1fr 1fr 1.7fr;

package/site/template.html

@@ -12,6 +12,7 @@
       content="An offline visual debugger for Codex AGENTS.md discovery. Explore instruction inheritance, hidden overrides, byte limits, and directory differences. No account or API key."
     />
     <meta name="theme-color" content="#f7f9f8" />
+    <!-- PUBLIC METADATA -->
     <meta
       property="og:title"
       content="Codex Context Map — Know what your agent reads"
@@ -155,6 +156,26 @@
             03 · Empty override
           </button>
         </div>
+        <div id="demo-share" class="demo-share" hidden>
+          <a
+            id="demo-link"
+            href="https://han-1413141.github.io/codex-context-map/"
+            target="_blank"
+            rel="noopener noreferrer"
+            data-i18n="openDemoLink"
+            >Open this demo link ↗</a
+          >
+          <button
+            id="copy-demo-link"
+            class="text-button"
+            data-i18n="copyDemoLink"
+          >
+            Copy link
+          </button>
+          <span data-i18n="shareHint"
+            >Shares this fictional scenario only.</span
+          >
+        </div>
         <div class="metrics">
           <div>
             <span data-i18n="loaded">FILES CONTRIBUTING</span
@@ -293,6 +314,11 @@
         <span data-i18n="independent"
           >Independent project. Not affiliated with OpenAI.</span
         ></span
+      ><a
+        id="guide-link"
+        href="https://han-1413141.github.io/codex-context-map/why-codex-ignores-agents-md.html"
+        data-i18n="guide"
+        >AGENTS.md troubleshooting guide ↗</a
       ><a
         href="https://github.com/Han-1413141/codex-context-map/issues"
         target="_blank"

package/src/report.js

@@ -19,7 +19,22 @@ export async function renderReport(snapshot, { demo = false } = {}) {
     .replace(/\u2028/g, "\\u2028")
     .replace(/\u2029/g, "\\u2029");
   const script = `${moduleBody(core)}\n${moduleBody(demoSource)}\nconst initialData = ${data};\n${app}`;
+  const publicMetadata = demo
+    ? `<link rel="canonical" href="https://han-1413141.github.io/codex-context-map/" />
+    <meta property="og:type" content="website" />
+    <meta property="og:site_name" content="Codex Context Map" />
+    <meta property="og:url" content="https://han-1413141.github.io/codex-context-map/" />
+    <meta property="og:image" content="https://han-1413141.github.io/codex-context-map/assets/social-preview.png" />
+    <meta property="og:image:width" content="1280" />
+    <meta property="og:image:height" content="640" />
+    <meta property="og:image:alt" content="Codex Context Map: AGENTS.md discovery, overrides and byte cutoffs, illustrated with fictional demo data." />
+    <meta name="twitter:card" content="summary_large_image" />
+    <meta name="twitter:title" content="Codex Context Map — Know what your agent reads" />
+    <meta name="twitter:description" content="An offline AGENTS.md discovery debugger. Try three fictional scenarios without an account or API key." />
+    <meta name="twitter:image" content="https://han-1413141.github.io/codex-context-map/assets/social-preview.png" />`
+    : '<meta name="robots" content="noindex, nofollow, noarchive" />';
   return template
+    .replace("<!-- PUBLIC METADATA -->", () => publicMetadata)
     .replace("/* STYLE */", () => css)
     .replace("/* SCRIPT */", () => script);
 }