Skip to content

AGENTS.md

Latest commit

 

History

History
55 lines (45 loc) · 3.95 KB

AGENTS.md

File metadata and controls

55 lines (45 loc) · 3.95 KB
Raw

AGENTS.md

1. Project structure

  • index.html is the homepage and about.html is the author profile.
  • article/ contains committed article pages, module/ contains category pages, data/ contains article/search indexes, and uploads/ contains article media.
  • site.css and article.css own presentation; site.js and article-search.js own browser behavior.
  • The root README files document the repository in English, Simplified Chinese, and Japanese.

2. Run commands

  • Preview from the repository root with python -m http.server 8000, then open http://localhost:8000/.
  • Do not claim that opening files directly verifies search; browser fetch() behavior depends on an HTTP origin.

3. Test commands

  • No test command was found in the current repository; add one before claiming automated regression coverage.
  • Manually verify homepage navigation, search suggestions, article links, the About language toggle, and wallpaper fallback.

4. Build commands

  • No build command was found in the current repository; committed HTML and index files are already generated deployment artifacts.

5. Code style

  • Keep the exact centered Shields language selector in all root README files; its visible SVG labels are English, 简体中文, and 日本語 so browser translation cannot rewrite them.
  • Keep English, Simplified Chinese, and natural Japanese content in the same section order with identical paths, counts, links, limitations, images, and code fences.
  • No lint / format command was found in the current repository.
  • Preserve UTF-8 article titles and paths, semantic HTML, keyboard-accessible search controls, and plain CSS/JavaScript.
  • Use textContent or explicit escaping for untrusted search text; do not interpolate raw query text into HTML.

6. Module boundaries

  • Homepage content and module navigation belong in index.html; author content and its language dictionary belong in about.html.
  • Shared wallpaper/cache behavior belongs in site.js; article-page search behavior belongs in article-search.js.
  • Article metadata changes must remain synchronized across article/, module/, data/articles.json, and search-index files.
  • Article media belongs in uploads/; do not move assets without updating every referring page.

7. Prohibited changes

  • Do not add a framework, package manager, or build step without also changing and documenting the GitHub Pages deployment model.
  • Do not bypass the Bing-host validation, request timeout, cache validation, or solid-color fallback in site.js.
  • Do not bulk-rewrite generated articles or indexes without a verified source mapping and link check.
  • Do not copy unlicensed badge-collection assets into the repository.

8. Completion criteria

  • Changed pages render through the local HTTP preview at desktop and mobile widths.
  • Search indexes, category links, article links, and moved/added media remain synchronized.
  • All three README files have working reciprocal language navigation and current commands.
  • README inventory counts are recomputed from the current recursive tree whenever article, module, data, upload, or root-file counts change.

9. Review criteria

  • Verify the language selector renders through GitHub without browser-translatable text and all three README versions keep the same facts, commands, links, and images.
  • Check keyboard navigation, visible focus, search suggestion roles, image alt text, and reduced-motion behavior.
  • Verify all local paths with case-sensitive GitHub Pages resolution in mind.
  • Run git diff --check and inspect changed HTML/JSON for accidental encoding corruption.

10. Common risks

  • Generated article pages and indexes can drift because no generator or validation command is committed.
  • The optional wallpaper path depends on bing.biturl.top and Bing image hosts; network failure must remain non-blocking.
  • Large media under uploads/ can increase clone and page-transfer size.
  • No license file was found, so content and media reuse rights are not declared.