Skip to content

docs: document AsciiDoc content conventions (EC-2178) - #260

Open
BohdanMar wants to merge 1 commit into
conforma:mainfrom
BohdanMar:ec-2178-asciidoc-conventions
Open

BohdanMar wants to merge 1 commit into
conforma:mainfrom
BohdanMar:ec-2178-asciidoc-conventions

Conversation

@BohdanMar

Copy link
Copy Markdown
Contributor

Summary

  • Document the AsciiDoc conventions used in the user guide, with examples for placeholders, page titles, navigation, admonitions, cross-references, and source blocks.
  • Note legacy title-casing exceptions and consistent step headings.

Closes #248

Jira: https://redhat.atlassian.net/browse/EC-2178

Validation

  • Checked the documented forms against existing .adoc pages.
  • git diff --check passed.
  • The preview command is blocked by a pre-existing Makefile path mismatch with the current website repository layout.

@BohdanMar
BohdanMar requested a review from a team as a code owner September 24, 2026 13:09
@coderabbitai

coderabbitai Bot commented Sep 24, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 21721b74-0ce0-4374-92db-5457c70eb014


Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document AsciiDoc content conventions in CLAUDE.md to reduce review rework

2 participants