Skip to content

IKE-Network/ike-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

519 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IKE Docs

Maven Central License Documentation IKE Network

Documentation plumbing for the IKE Network. Provides the ike-doc-maven-plugin (idoc:* render and packaging goals), the Koncept AsciiDoc extension, DocBook XSL + fonts, shared doc resources, and a semantic linebreak reformatter.

Split from the archived ike-pipeline repo. See IKE-Network/ike-issues#216 for the architectural rationale.

Modules

Module Artifact Purpose
ike-doc-resources network.ike.docs:ike-doc-resources Shared build resources (themes, assembly descriptors, renderer configs)
minimal-fonts network.ike.docs:minimal-fonts Noto font subset for PDF rendering (ZIP)
docbook-xsl network.ike.docs:docbook-xsl DocBook XSL 1.79.2 + IKE FO customization
koncept-asciidoc-extension network.ike.docs:koncept-asciidoc-extension AsciidoctorJ k:Name[] inline macro + glossary
ike-doc-maven-plugin network.ike.docs:ike-doc-maven-plugin idoc:* goals: AsciiDoc rendering, multi-renderer PDF wrappers, doc packaging utilities
semantic-linebreak network.ike.docs:semantic-linebreak AsciiDoc one-sentence-per-line reformatter

Build

mvn clean install

Requires Java 25 and a Maven 4 wrapper (./mvnw). The ike-build-standards artifact (from network.ike.tooling) is fetched automatically at validate and unpacks Claude standards into .claude/standards/ for each module.

Release Position

ike-tooling  →  ike-docs  →  ike-platform  →  { doc-example, project-example, integration-tests-example }  →  workspace-reactor-example

ike-docs releases before ike-platform because ike-platform's ike-parent declares ike-doc-maven-plugin and the other ike-docs artifacts (themes, fonts, DocBook XSL, koncept extension) in its <pluginManagement> and <dependencyManagement> at ${ike-docs.version}. Those artifacts must be resolvable from Nexus when downstream reactors load.

The cascade ordering is structurally upstream-first; it is not driven by extension-realm timing. Earlier revisions of these docs cited <extensions>true</extensions> and literal-version pinning as the reason — that constraint was eliminated in IKE-Network/ike-issues#321 when ike-doc-maven-plugin retired its <packaging>ike-doc</packaging> custom type in favor of a classifier-canonical doc shape. See ike-doc-maven-plugin/src/site/asciidoc/index.adoc for the full design rationale.

Doc as Code + LLM-Friendly

ike-docs follows the IKE Network's doc-as-code philosophy: build conventions, documentation standards, and AI-assistant guidance live as versioned Markdown files in ike-build-standards and are unpacked into every consumer's .claude/standards/ at the validate phase. When a developer — or Claude itself — opens an IKE project, the agent reads the standards from .claude/standards/ and applies them automatically; contributors don't have to memorize the conventions.

The standards most directly relevant to ike-docs are IKE-DOC.md (module shapes, classifier-canonical attachment), IKE-DIAGRAMS.md (PlantUML / GraphViz authoring), and IKE-ASCIIDOC-FRAGMENT.md (fragment-style topic authoring). See the full inventory.

Links

License

Apache License 2.0. See the project pom.xml or apache.org/licenses/LICENSE-2.0.

About

IKE documentation plumbing — ike-doc-maven-plugin, koncept-asciidoc-extension, minimal-fonts, docbook-xsl, ike-doc-resources, semantic-linebreak. Split from ike-pipeline per IKE-Network/ike-issues#216.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors