meta

Contributing to the XRAYN Vault

Rules for humans and LLM agents adding content.

Adding a new system

  1. Research first. Use the research query templates to gather specs, common failure modes, successors/predecessors, and real part numbers. Cite sources.
  2. Pick the right entity type.
    • New model (different specs / chassis / platform) = new family + variant cards
    • New configuration on same chassis = new variant card under existing family
    • New licensing tier (e.g. ClarityIQ upgrade) = new variant card
  3. Copy a template. From _templates/, substitute placeholders.
  4. Follow the style guide. Voice, forbidden content, linking rules.
  5. Run the validation checklist. Every required section + frontmatter field must be populated or explicitly marked "planned".
  6. Cross-link aggressively. Every system links to manufacturer, modality, family, sibling variants, predecessor/successor, field guide, glossary terms used. Cross-link network is the product.
  7. Add to Home.md + MOC page.

Adding a new modality

  1. Create modalities/<modality>.md — physics, history, key specs, systems, service reality
  2. Create schemas/<modality>.md — frontmatter field schema
  3. Create at least one iconic family + variants
  4. Create one shared field guide under the family
  5. Update Home + modality MOC page

Adding a new part

  1. Frontmatter fits_systems: [...] must list every variant slug the part fits
  2. Link back to field-guide anchor
  3. State the typical failure mode succinctly
  4. Cross-link to any glossary term the part uses (e.g. anode, MHU, scintillator)

Adding a new glossary term

  1. Plain-language definition in one paragraph
  2. "Why it matters to buyers" and "Why it matters to engineers" (both matter)
  3. At least two wikilinks to systems that use the concept
  4. Cross-link to related glossary terms

Refusing to add

Some content doesn't belong in the vault:

When unsure