Put the title page and front matter first in the nav - #172
Merged
Merged
Conversation
Match the template's nav.adoc: the title page (index.adoc) is the
top-level entry, and copyright, contributors, the introduction and then
the chapters are nested under it, in that order. The PDF already opens
title page, copyright, contributors, Chapter 1.
The nav had no title-page entry at all, which MIGRATION.md Step 9 asks
for ("landing page first"), and carried copyright and contributors at the
end. They went there in #169 on the stated grounds that the central
playbook numbers this component's chapters by line number in this file.
That was never checked and is wrong: docs-dev-guide's content source is
commented out in both antora.riscv.org and antora-dev.riscv.org, and
neither has a numbering rule for docs-guide. The comment asserting it is
removed. In its place is the template's own header comment, which warns
about line-number coupling in general terms -- true once this guide is
registered centrally.
The `.Authoring and Editing RISC-V Specs` nav title goes too: the
title-page entry, labelled with the component title, takes its place, as
in the template.
antora-structure.adoc: the guide's example nav -- the one template users
copy -- listed spec-sample.adoc as the landing page (the template's is
index.adoc), put contributors after the chapters, and left out copyright.
It now matches the template's nav.adoc entry for entry.
Verified: Antora builds with the same single pre-existing warning and no
errors; the rendered sidebar reads RISC-V Authoring and Editing Guide >
Copyright and license information > Contributors > Introduction > ...,
nested under the title page.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Bill Traynor <wmat@riscv.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #171. That PR merged before this commit arrived, so it needs its own.
Puts the nav in the same order as the template and the PDF: title page, copyright,
contributors, introduction, then the chapters.
What changes
nav.adocnow follows the template's structure: the title page (index.adoc) is thetop-level entry, and copyright, contributors, the introduction and the chapters are
nested under it, in that order. The PDF already opens title page → copyright →
contributors → Chapter 1.
MIGRATION.mdStep 9 asks for one("landing page first").
that the central playbook numbers this component's chapters by line number in this
file. That was never checked, and it's wrong: docs-dev-guide's content source is
commented out in both
antora.riscv.organdantora-dev.riscv.org, and neither has anumbering rule for
docs-guide. The comment claiming otherwise is replaced by thetemplate's own header comment, which warns about line-number coupling in general terms
— true once this guide is registered centrally.
.Authoring and Editing RISC-V Specsnav title is dropped. The title-page entry,labelled with the component title, takes its place, as in the template.
antora-structure.adoc— the onetemplate users copy — listed
spec-sample.adocas the landing page (the template's isindex.adoc), put contributors after the chapters, and left out copyright. It nowmatches the template's
nav.adocentry for entry.Verification
information › Contributors › Introduction › …, nested under the title page.
🤖 Generated with Claude Code