中文

ONNX GenAI Wiki

Using this Wiki

Properties4
statusmaintained
created2026-08-17
updated2026-08-19
tagswiki, obsidian, contributing

4 min read

Using this Wiki

Question answered

How should contributors open, link, date and maintain this repository wiki in Obsidian?

Open the vault

Open the repository’s wiki/ directory as an Obsidian vault. The notes use standard Markdown, YAML properties, wikilinks, callouts and Mermaid diagrams. No community plugin is required to read them.

Naming

  • Use English filenames and title properties for stable cross-language links.
  • Bodies are written in Simplified Chinese; filenames, the frontmatter title, and the page’s top-level heading (H1) stay in English.
  • Use descriptive noun phrases, not issue numbers or temporary project phases.
  • Organize by durable domain: start/, architecture/, execution/, memory/, meta/, and future peer domains.

Required properties

---
title: Stable English Title
aliases:
  - Optional alternate title
tags:
  - domain
status: maintained
lang: zh-CN
created: 2026-08-17
updated: 2026-08-17
---

lang is a required field. Quartz uses its value directly as the published page’s <html lang> attribute, so it affects real accessibility and search-engine behavior. Chinese notes use lang: zh-CN.

Suggested statuses:

StatusMeaning
maintainedIntended to track current understanding
proposedExplains a target design that is not fully implemented
historicalPreserved context, not current guidance
draftIncomplete and not ready to rely on

Can Obsidian show creation and modification times?

Yes, with two different meanings:

Version-controlled properties

created and updated appear in Obsidian’s Properties view and are stored in Git. These are the wiki’s durable dates.

  • Set created when adding a note.
  • Change updated when materially changing its meaning.
  • Do not change updated for whitespace-only or link-only maintenance unless the repository adopts a different convention.

Obsidian Core does not reliably auto-update a custom updated property whenever the note changes. A Linter/Templater-style plugin or repository automation can do that, but contributors should not need a plugin to produce valid notes.

Filesystem timestamps

Obsidian and plugins can inspect local file creation/modification timestamps. These are useful locally but unreliable as repository history:

  • cloning creates new local files;
  • checkout/rebase can change mtimes;
  • different filesystems preserve metadata differently;
  • Git does not version filesystem creation time.

Use Git history for exact change provenance:

git log --follow -- "wiki/path/Note.md"

Important

Frontmatter dates describe note-level editorial history. Git commits remain the authoritative record of who changed which lines and when.

Linking

Prefer wikilinks for wiki concepts:

[[architecture/Crate Architecture]]
[[execution/Execution Backends|backend overview]]

Use normal relative Markdown links for source files under docs/ or crates/, because GitHub renders them correctly and they represent formal sources:

[Memory Architecture](../../docs/memory/MEMORY_ARCHITECTURE.md)

Preview and publish the static site

The site generator does not live in this repository. wiki/ is the only source of content, and publishing is handled by justinchuby/onnx-genai-wiki, which mirrors wiki/ into its own content/zh/ on a schedule, derives an English edition from it, and publishes both as a bilingual site with a language switcher.

Two things follow. First, notes are still edited only here; pushing to main syncs them across automatically, so there is no second copy to maintain. Second, do not edit content/zh/ in onnx-genai-wiki directly — it is a mirror, and the next sync replaces it wholesale.

To preview locally, clone that repository:

git clone https://github.com/justinchuby/onnx-genai-wiki
cd onnx-genai-wiki/site/quartz
npm ci
npm run wiki:serve

The published address is https://www.justinchuby.com/onnx-genai-wiki/.

Inside this repository the only check worth running before committing a note is whether its wikilinks resolve — that one needs no site generator, and the onnx-genai-wiki build checks it again anyway, additionally requiring that the Chinese and English editions produce exactly the same set of pages.

Human reading budget

Each note should answer one primary question and usually take roughly 5–10 minutes to read. This is a navigation aid, not a hard size limit. Keep a longer tutorial when a beginner needs its definitions and reasoning in one continuous reading path.

Prefer a small map of linked notes over one chapter that tries to preserve every implementation detail, but do not make readers chase links just to understand the article. A wiki note should stand on its own for its intended audience. Formal specifications and source code support verification and deeper implementation work; they are not prerequisites for understanding the note.

Avoid duplicated truth

Do not copy large changing status tables or exhaustive normative contracts into the wiki. Do include enough definitions, examples and constraints for a human to understand the topic without opening another file. Link authoritative sources so claims remain verifiable and maintainers can find implementation details.

Note template

---
title: Note Title
aliases: []
tags:
  - domain
status: draft
lang: en
created: YYYY-MM-DD
updated: YYYY-MM-DD
---
 
# Note Title
 
> [!summary] The question this note answers
> 
> One sentence on what a reader gets from this note.
 
## Overview
 
...
 
## Authoritative sources
 
- [Source](../../docs/path.md)
 
## Related notes
 
- [[start/Repository Map]]

Graph View

Backlinks