antora.yml

---
# Antora Component Descriptor
# https://docs.antora.org/antora/latest/component-version-descriptor/
#
# This file defines the Antora component for this RISC-V specification.
# Rename `name` and `title` to match your specification.
#
# Keep this file minimal. When this repo is published as a content source in the
# central playbook (github.com/riscv-admin/antora.riscv.org), that playbook
# supplies the shared AsciiDoc attributes (doctype, icons, xrefstyle,
# source-highlighter, kroki config, math entities, ...) and the extensions
# (asciidoctor-kroki, mathjax, bibliography, section/nav numbering) uniformly to
# every spec. Attributes set HERE would override the playbook and desync this
# spec from the rest of the library -- notably `sectnums`, which the central
# section-numbering extension controls per component. Put preview-only rendering
# config in antora-playbook.yml (which mirrors production), not here.

name: spec-sample
title: RISC-V Example Specification (Zexmpl)
# The site version is kept in EXACT lockstep with the ARC submission PDF: it is
# the vX.Y release tag, per the ARC Author Guide. Do not hand-edit -- it is
# stamped from scripts/release-info.sh (the same source the PDF build uses) by
# scripts/stamp-antora-version.sh / `make stamp-antora`, so the site path
# (/spec-sample/<version>/) and the released PDF filename always match.
version: v0.0

nav:
  - modules/ROOT/nav.adoc

asciidoc:
  attributes:
    page-group: isa
    # Path (Antora resource ID) to this spec's BibTeX database, consumed by the
    # central playbook's ASAM bibliography extension to resolve `cite:` macros and
    # render `bibliography::[]`. Without it the extension no-ops and those appear
    # as raw text. This is a spec-SPECIFIC resource the central playbook cannot
    # supply, so it legitimately belongs here (not a rendering-attribute override).
    asamBibliography: ROOT:resources/riscv-spec.bib
    # Cover logo for index.adoc, as an Antora resource ID. The default is the
    # shared asset from the central `common` component, which is what the
    # riscv.org production build uses. A single-repo build has no `common`
    # component, so scripts/build-pages-site.sh (GitHub Pages) hard-sets this in
    # its generated playbook to a copy vendored from the docs-resources
    # submodule. Indirection lives here so neither build has to special-case the
    # page itself.
    cover-logo: common::risc-v_logo.svg
    # Release metadata for the cover page (index.adoc), kept in lockstep with the
    # PDF title page. Spec-SPECIFIC (the central playbook cannot know this spec's
    # version/phase), so it belongs here -- like asamBibliography above, not a
    # shared-rendering override. Stamped by scripts/stamp-antora-version.sh; the
    # `version:` key above is the authoritative version and page-revnumber mirrors
    # it for display. Do not hand-edit.
    page-revnumber: v0.0
    page-revdate: 2026-07-14
    page-phase: draft-and-development
    page-phase-display: 'Draft and Development'
    page-phase-notice: 'Assume everything is subject to change. At this stage, ideas, structures, and content are still evolving. Feedback and iteration are encouraged as nothing is final, and adjustments may be frequent.'