Refactor documentation: clarify configuration, prompt system, and deterministic headers - #119
Merged
Merged
Conversation
…format The .ai.md header carries only deterministic metadata (h,c,d,t,g,a,x) and all AI content now lives in one markdown body — there is no s/k field and no separate keyword extraction. Correct the stale docs to match the code: - README example output: drop the non-existent `- K:` header line and the `#### <file>` body shape; show the real header field order (incl. `- A:`), the `---` separator, and the blockquote-lead + `####` sections produced by the `file-body` prompt (AiMdHeaderCodec.write / AiMdDocumentCodec.write). - README prompt system: replace the file-summary/file-keywords/ package-summary/package-keywords list with the real `file-body` / `package-body` keys and how they are wired via promptDefinitions / fieldGenerations. - README: fix the keyword-extraction feature bullet and rename the `llamaMaxTokens` parameter to the real `llamaMaxOutputTokens`. - CLAUDE.md: replace "(with s/k filled)", "summary/keywords fields" and "fields (s, k)" with single-body wording. Docs-only; no production code touched. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RvxJko6xiCx83LxKgj92mH
…nerations setup The old "Configuration" section showed a `<properties>` minimal setup with `ai.index.model.path` — a property nothing in the code or POM reads — and hid that `<fieldGenerations>` is mandatory (SourceFileIndexer/PackageIndexer throw IllegalArgumentException when it is absent). Replace it with the actual, working mechanism, verified against the ai-index-selftest profile in pom.xml: - Explain the three building blocks: <aiDefinitions> (models by key), <promptDefinitions> (templates by key, two %s placeholders), and <fieldGenerations> (per goal: promptKey -> aiDefinitionKey, required). - Provide a complete, runnable <plugin> example with both executions bound to generate-resources / process-resources (matching the self-test profile). - Rework the "Plugin Configuration" parameter list: drop the misleading top-level llama* model parameters (a non-functional fallback — model params come from <aiDefinition>), add fileExtensions/force/skip/aiDefinitions/ promptDefinitions/fieldGenerations with their real defaults. Docs-only; no production code touched. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RvxJko6xiCx83LxKgj92mH
bernardladenthin
had a problem deploying
to
startgate
June 26, 2026 07:00 — with 
GitHub Actions
Error
GitHub Actions
Error
|
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
2 participants
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.
Summary
<aiDefinitions>,<promptDefinitions>, and<fieldGenerations>per goal. Replaced minimal/outdated POM snippet with full XML demonstrating model definition, prompt templates, and execution binding.<fieldGenerations>..ai.mdskeleton (header) is deterministic, while only the AI-generated body varies.<fieldGenerations>is required per goal.Test plan
Related issues / PRs
N/A
Checklist
CONTRIBUTING.mdandCODE_OF_CONDUCT.mdhttps://claude.ai/code/session_01RvxJko6xiCx83LxKgj92mH