Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,9 @@
* xref:linting.adoc[Linting]
* xref:build-infrastructure.adoc[Build Infrastructure]
* xref:bibliography.adoc[Bibliography]
// Back matter. Appended rather than placed up front (where the template puts
// them) so the chapter line numbers above do not shift: the central playbook's
// numbering_rules entry for this component keys chapters off LINE NUMBERS in
// this file. See MIGRATION.md Step 11.
* xref:contributors.adoc[Contributors]
* xref:copyright.adoc[Copyright and license information]
4 changes: 2 additions & 2 deletions modules/ROOT/pages/author-quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ src/spec-sample.adoc <9>
<1> Images used in the spec. These are referenced from the chapter files and included in both PDF and HTML output.
<2> Site landing / cover page. HTML-only -- **not** part of the PDF. Follow the instructions in this file to update the content.
<3> The introduction chapter. Becomes "Chapter 1" in the PDF.
<4> Front matter that lists contributors. HTML only -- **not** part of the PDF. Follow the instructions in this file to update the content.
<5> Copyright and license information. HTML only -- **not** part of the PDF. Follow the instructions in this file to update the content.
<4> Front matter that lists contributors. Included in both PDF and HTML: the site navigation renders it as a page, and the PDF assembler includes it as a `[preface]` ahead of the first chapter. Follow the instructions in this file to update the content.
<5> Copyright and license information. Included in both PDF and HTML, the same way as the contributors file. Follow the instructions in this file to update the content.
<6> Bibliography main page. Included in both PDF and HTML and uses the bibliography database (`riscv-spec.bib`) to render the references.
<7> Bibliography database.
<8> HTML navigation file -- Update references to your chapter files here. This is the site navigation that builds the HTML output.
Expand Down
16 changes: 16 additions & 0 deletions modules/ROOT/pages/contributors.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
== Contributors

This guide has been contributed to directly or indirectly by:

[%hardbreaks]
* Kevin Broch
* Stephano Cetola

Check failure on line 7 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L7

[Vale.Spelling] Did you really mean 'Stephano'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Stephano'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 7, "column": 3}}}, "severity": "ERROR"}

Check failure on line 7 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L7

[Vale.Spelling] Did you really mean 'Cetola'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Cetola'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 7, "column": 12}}}, "severity": "ERROR"}
* Paul A. Clarke
* Brian Grayson

Check failure on line 9 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L9

[Vale.Spelling] Did you really mean 'Grayson'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Grayson'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 9, "column": 9}}}, "severity": "ERROR"}
* Jeff Osier-Mixon
* Kersten Richter

Check failure on line 11 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L11

[Vale.Spelling] Did you really mean 'Kersten'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Kersten'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 11, "column": 3}}}, "severity": "ERROR"}
* Elisa Sawyer
* Jeff Scheel

Check failure on line 13 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L13

[Vale.Spelling] Did you really mean 'Scheel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Scheel'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 13, "column": 8}}}, "severity": "ERROR"}
* Josh Scheid

Check failure on line 14 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L14

[Vale.Spelling] Did you really mean 'Scheid'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Scheid'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 14, "column": 8}}}, "severity": "ERROR"}
* Rafael Sene
* Bill Traynor

Check failure on line 16 in modules/ROOT/pages/contributors.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/ROOT/pages/contributors.adoc#L16

[Vale.Spelling] Did you really mean 'Traynor'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Traynor'?", "location": {"path": "modules/ROOT/pages/contributors.adoc", "range": {"start": {"line": 16, "column": 8}}}, "severity": "ERROR"}
9 changes: 9 additions & 0 deletions modules/ROOT/pages/copyright.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[preface]
== Copyright and license information

This documentation is licensed under the Creative Commons
Attribution 4.0 International License (CC-BY 4.0). The full
license text is available at
https://creativecommons.org/licenses/by/4.0/.

Copyright 2026 by RISC-V International.
40 changes: 36 additions & 4 deletions src/docs-dev-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ ifndef::revnumber[:revnumber: v0.0]
ifndef::revdate[:revdate: 1970-01-01]
ifndef::spec_short[:spec_short: docs-dev-guide]
:revinfo:
// Shared RISC-V attributes (:company:, :url-riscv:, :doctype: book) from the
// docs-resources submodule, so this document picks up changes to them centrally.
// PDF-ONLY: this cross-repo relative include cannot resolve under Antora, which
// is why it lives in the assembler and never in a page. See MIGRATION.md Step 7.
include::../docs-resources/global-config.adoc[]
//:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
:description: A working template for documenting RISC-V architecture in asciidoc
:company: RISC-V.org
:url-riscv: http://riscv.org
:doctype: book
//:preface-title: Preamble
//:colophon:
//:appendix-caption: Appendix
Expand All @@ -34,7 +36,10 @@ ifndef::spec_short[:spec_short: docs-dev-guide]
:lang: en
:listing-caption: Listing
:sectnums:
:toc: left
// `macro` rather than `left` so the toc::[] call below controls placement -- the
// TOC follows the front matter, as in the template's assembler.
:toc: macro
:toc-title: Table of Contents
:toclevels: 4
:source-highlighter: pygments
ifdef::backend-pdf[]
Expand All @@ -57,6 +62,27 @@ endif::[]

//This document is released under a Creative Commons Attribution 4.0 International License.

// This repo runs in doc mode, so there is no "Document State" preface to render
// ahead of the TOC -- see MIGRATION.md "Doc mode".
toc::[]

[preface]
== List of figures
list-of::image[hide_empty_section=true, enhanced_rendering=true]

[preface]
== List of tables
list-of::table[hide_empty_section=true, enhanced_rendering=true]

[preface]
== List of listings
list-of::listing[hide_empty_section=true, enhanced_rendering=true]

include::../modules/ROOT/pages/copyright.adoc[]

[preface]
include::../modules/ROOT/pages/contributors.adoc[]

include::../modules/ROOT/pages/intro.adoc[]

include::../modules/ROOT/pages/author-quickstart.adoc[]
Expand All @@ -83,4 +109,10 @@ include::../modules/ROOT/pages/linting.adoc[]

include::../modules/ROOT/pages/build-infrastructure.adoc[]

// The index must precede the bibliography. The index macro is PDF-only (Antora
// does not generate a back-of-book index), so it lives here in the assembler
// rather than in a page.
[index]
== Index

include::../modules/ROOT/pages/bibliography.adoc[]
Loading