Skip to content

docs(tutorial): add AI-powered template generation setup guide#500

Open
arodage wants to merge 5 commits intomainfrom
docs/ai-template-generation-tutorial
Open

docs(tutorial): add AI-powered template generation setup guide#500
arodage wants to merge 5 commits intomainfrom
docs/ai-template-generation-tutorial

Conversation

@arodage
Copy link
Copy Markdown
Contributor

@arodage arodage commented Mar 31, 2026

Merge Checklist

All boxes should be checked before merging the PR

  • The changes in the PR have been built and tested
  • Documentation has been updated to reflect the changes (or no doc update needed)
  • Ready to merge

Description

Add a tutorial for trying/testing Phase 1 of AI-powered template generation using RAG.

Changes included:

  • Added docs/tutorial/ai-template-generation.md with setup, quick start (Ollama/OpenAI), CLI usage, configuration, troubleshooting, and metadata guidance
  • Updated docs/tutorial/usage-guide.md to include the ai command and a link to the new tutorial

No code behavior changes, docs-only update.

Any Newly Introduced Dependencies

None.

How Has This Been Tested?

  • Documentation-only change; no runtime tests were executed in this step.

@arodage arodage requested a review from a team as a code owner March 31, 2026 17:52
Copilot AI review requested due to automatic review settings March 31, 2026 17:52
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation for the new AI-powered template generation workflow (Phase 1 RAG) and links it from the main tutorial usage guide.

Changes:

  • Added a new tutorial: docs/tutorial/ai-template-generation.md (setup, quick start, CLI usage, config, troubleshooting, metadata guidance).
  • Updated docs/tutorial/usage-guide.md to list the ai command and link to the new tutorial.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File Description
docs/tutorial/usage-guide.md Exposes the ai command in the CLI overview and adds a “Related Documentation” link to the new tutorial.
docs/tutorial/ai-template-generation.md New end-to-end tutorial for using the AI/RAG template generation feature.

@arodage
Copy link
Copy Markdown
Contributor Author

arodage commented Mar 31, 2026

Addressed Copilot review comments in commit 9424748.

  • Updated Ollama default chat model references to llama3.1:8b (setup, zero-config, troubleshooting)
  • Corrected model-configuration wording (provider flag chooses provider, not model)
  • Clarified overwrite prompt behavior (only when output matches templates returned by current search results)
  • Clarified OpenAI provider selection is currently via CLI flag --provider openai
  • Aligned config YAML example with actual schema (chat_model, timeout as duration strings, scoring *_weight keys)
  • Removed unsupported env var override claims (OLLAMA_HOST, OIC_AI_PROVIDER)
  • Updated metadata example to schema-valid fields (use_cases, keywords; removed unsupported fields)

Please re-review when convenient.

Copy link
Copy Markdown
Contributor

@magerstam magerstam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks pretty good to me. I think there is a discussion we should have around further improve this for UX and efficacy but for the intents and purposes of this initial submission this looks good!

Copy link
Copy Markdown
Contributor

@kblaszczak-intel kblaszczak-intel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Great. We may have a second look once it builds.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants