feat: add private-coding-assistant quickstart

[itay1551]

Publication suggestion PR

Thank you for suggesting a quickstart for publication on redhat(dot)com! Please complete the sections below fields so reviewers have enough context and leave checkboxes unchecked.

Summary

Stages private-coding-assistant for publication. It deploys a private self-hosted AI coding assistant on OpenShift (Dev Spaces + vLLM/llm-d, optional RHCL AI Gateway) so developers get IDE-integrated AI help without sending source outside the cluster. Target audience: platform/engineering teams that need on-prem or VPC-bound coding assistants with governance.

Publication readiness checklist

• README is clear, concise, and free of typos
• README is accurate and includes vertical use case
• README is complete and follows template structure
• Quickstart runs end-to-end without errors and is reproducible
• Titles, descriptions, and tags adhere to MIST guidelines
• Insert redhat(dot)com requirements here
• Confirm markdown links use accessible "alt text" descriptions
• Technical review complete
• Peer review complete
• Marketing review complete (accurately convey purpose of quickstart ->
  demo, not production-ready code supported by RH)
• Known issues and requests are documented (or resolved)

[github-actions]

📋 Automated Documentation Review

Submodule: quickstart/private-coding-assistant
Source Repo: rh-ai-quickstart/private-coding-assistant
Commit: a9ea1d17aafb756c03a12bc7eb9e54c1a0bd9042

---

📊 Summary

Severity	Count
🚫 Blockers	2
⚠️ Major	3
ℹ️ Minor	2
💡 Suggestions	1
Total	8

---

🚫 Blockers (2)

H1 title exceeds 64 character limit

Category: structure | Location: Line 1: # Private AI Code Assistant on Red Hat OpenShift

The H1 title 'Private AI Code Assistant on Red Hat OpenShift' is 50 characters, which is acceptable. However, the requirement states titles must be action-focused and start with an action verb (Deploy, Boost, Accelerate). This title starts with an adjective 'Private' rather than an action verb.

Suggested Fix: Change to an action-focused title starting with a verb, such as: 'Deploy a Private AI Code Assistant on Red Hat OpenShift' (58 chars)

Requirement: CONTRIBUTING.md#readme-structure-requirements - 'Max length: 64 chars, action-focused & starts with an action verb (Deploy, Boost, Accelerate)'

---

Tags section missing required format with bold keys

Category: structure | Location: ## Tags section at bottom of README

The Tags section exists but does not follow the required bulleted list format with bold keys and normal-text values. Current format uses '- Title:' and '- Description:' which are not the required tag types. Required tags are Industry, Product, Partner (if applicable), and Use case (optional).

Suggested Fix: Replace the current tags section with:

• Industry: Media and IT services
• Product: OpenShift AI
• Use case: AI coding assistant, private inference

Requirement: CONTRIBUTING.md#required-tag-format - 'Tags must be a bulleted list, with bold key & normal-text value' and PUBLISHING.md - 'Tag format: Tags must be in dedicated section at the bottom of the README, in a bulleted list with key and value pairs with key in bold and value in normal text'

---

⚠️ Major Issues (3)

Trademark symbols used incorrectly throughout README

Category: style | Location: Throughout README, starting with H1 title and first paragraph

Red Hat® and OpenShift® trademark symbols appear to be missing on first mention. The README should use 'Red Hat® OpenShift®' on first mention only, then 'OpenShift' or 'Red Hat OpenShift' on subsequent mentions. The first mention in the H1 title shows 'Red Hat OpenShift' without trademark symbols.

Suggested Fix: On first mention in the H1 or opening paragraph, use 'Red Hat® OpenShift®'. All subsequent mentions can use 'OpenShift' or 'Red Hat OpenShift' without symbols. Also ensure 'Red Hat OpenShift AI' follows the same pattern per the Official Product Names List.

Requirement: PUBLISHING.md#naming-and-branding-consistency - 'The First Mention Rule: Use the full product name with the appropriate trademark symbol on the first mention only'

---

Requires cluster-admin permissions (violates Level 3 best practices)

Category: content | Location: ## Requirements > ### Required user permissions

The 'Required user permissions' section explicitly states 'OpenShift cluster-admin' is required for all deployment paths. This violates the best practice that good quickstarts should be 'Deployable by regular users with standard permissions' not 'Only deployable by cluster admins'.

Suggested Fix: If cluster-admin is truly required, this is acceptable for Level 1-2 quickstarts but limits advancement to Level 3. Consider documenting specific RBAC permissions needed and providing a role/rolebinding that could allow non-admin deployment, or acknowledge this limitation in the documentation.

Requirement: CONTRIBUTING.md#what-makes-a-good-quickstart - '✅ Best Practices: Deployable by regular users with standard permissions' vs '❌ Common Pitfalls: Only deployable by cluster admins'

---

Missing 'See it in action' section with demo links

Category: structure | Location: Missing between 'Detailed description' and 'Architecture diagrams'

The README structure requirements list 'See it in action' (H3) as 'Recommended' with links to videos/Arcades. This section is completely absent from the README, which would help users without deployment environments experience the quickstart.

Suggested Fix: Add an H3 section after 'Detailed description' titled '### See it in action' with links to demo videos, Arcade experiences, or screenshots showing the deployed solution in use.

Requirement: CONTRIBUTING.md#readme-structure-requirements - Order 5: 'See it in action' H3, Recommended, 'Link to videos/Arcades for users without environments'

---

ℹ️ Minor Issues (2)

Architecture diagrams section uses H3 instead of being standalone

Category: structure | Location: ### Architecture diagrams (currently H3 under Detailed description)

The 'Architecture diagrams' section is currently an H3 under 'Detailed description'. According to the README structure requirements, it should be its own H3 section at order position 6, not nested under another section.

Suggested Fix: Move '### Architecture diagrams' to be a top-level H3 section after the 'Detailed description' H2 section closes, not nested within it.

Requirement: CONTRIBUTING.md#readme-structure-requirements - Order 6: 'Architecture diagrams' should be H3 at the same level as other major sections

---

Short description slightly exceeds recommended brevity

Category: content | Location: Line 3: Short description text below H1

The short description 'Deploy a private self-hosted AI coding assistant on OpenShift so developers get AI-powered IDEs while no code leaves your environment' is 154 characters, which is within the 160 character limit. However, it could be more concise to improve readability and SEO impact.

Suggested Fix: Consider tightening to: 'Deploy a private AI coding assistant on OpenShift with AI-powered IDEs that keep all code within your environment' (122 chars) - more concise while retaining key value propositions.

Requirement: CONTRIBUTING.md#readme-structure-requirements - 'Max length: 160 chars, explains what users will learn/gain'

---

💡 Suggestions (1)

Consider adding AI transparency disclaimer for the solution

Category: content | Location: Detailed description section and/or Documentation references

The quickstart deploys AI-powered coding assistants (Continue, Cline, Roo Code) but doesn't explicitly mention whether the deployed solution includes UI elements that clearly label AI-generated code suggestions to end users. The Contributing guidelines emphasize AI transparency in user interfaces.

Suggested Fix: Consider adding a note in the 'Features' or 'Detailed description' section mentioning that the IDE extensions provide clear indicators when code is AI-generated and include prompts for developers to verify suggestions. If this isn't currently implemented, consider it as a future enhancement.

Requirement: CONTRIBUTING.md#ai-transparency-in-user-interfaces - 'Clearly label AI-generated content in the UI' and 'Include visible disclaimers prompting users to verify AI outputs'

---

🤖 Automated review powered by Claude

[itay1551]

Both comments above from the verification agent are incorrect:

• The title complies with the character limit.
• We already have bullet points for the tags.

We comply with all of the feedback. Please let us know if anything is missing.

[github-actions]

📋 Automated Documentation Review

Submodule: quickstart/private-coding-assistant
Source Repo: rh-ai-quickstart/private-coding-assistant
Commit: a9ea1d17aafb756c03a12bc7eb9e54c1a0bd9042

---

📊 Summary

Severity	Count
🚫 Blockers	2
⚠️ Major	3
ℹ️ Minor	2
💡 Suggestions	1
Total	8

---

🚫 Blockers (2)

H1 title exceeds 64 character limit

Category: structure | Location: Line 1: # Private AI Code Assistant on Red Hat OpenShift

The H1 title 'Private AI Code Assistant on Red Hat OpenShift' is 50 characters, which is acceptable. However, the title does not start with an action verb as required. The title should be action-focused and start with verbs like 'Deploy', 'Boost', 'Accelerate', etc.

Suggested Fix: Change title to start with an action verb, for example: 'Deploy a Private AI Code Assistant on Red Hat OpenShift' or 'Build a Private AI Code Assistant on Red Hat OpenShift'

Requirement: CONTRIBUTING.md#readme-structure-requirements - 'Max length: 64 chars, action-focused & starts with an action verb (Deploy, Boost, Accelerate)'

---

Tags section formatting does not meet requirements

Category: structure | Location: ## Tags section at bottom of README

The Tags section exists but does not follow the required format. Tags must be in a bulleted list with bold keys and normal-text values. Current format shows '- Title:' and '- Description:' which are not valid tag categories. Required tags are Industry, Product, Use case, and optionally Partner.

Suggested Fix: Replace the Tags section with proper format:

Tags

• Industry: Media and IT services
• Product: OpenShift AI
• Use case: AI coding assistant, private inference

Requirement: CONTRIBUTING.md#required-tag-format - 'Tags must be a bulleted list, with bold key & normal-text value' and PUBLISHING.md - 'Tag format: Tags must be in dedicated section at the bottom of the README, in a bulleted list with key and value pairs with key in bold and value in normal text'

---

⚠️ Major Issues (3)

Trademark symbols used incorrectly throughout README

Category: style | Location: Throughout README, particularly in title, detailed description, and solution stack sections

Red Hat® and OpenShift® trademarks appear to be missing on first mention. The first mention rule requires full product names with appropriate trademark symbols on first use only (e.g., 'Red Hat® OpenShift®'), with subsequent mentions using approved short names without symbols.

Suggested Fix: On first mention in the README body (not title), use 'Red Hat® OpenShift®' and 'Red Hat® OpenShift® AI'. Subsequent mentions can use 'OpenShift' and 'OpenShift AI' without symbols. Example: In the detailed description section, first mention should be 'This quickstart deploys on Red Hat® OpenShift®...'

Requirement: PUBLISHING.md#naming-and-branding-consistency - 'The First Mention Rule: Use the full product name with the appropriate trademark symbol on the first mention only'

---

Product name inconsistency - RHCL vs official name

Category: content | Location: Multiple locations: detailed description, solution stack table, architecture diagrams section

The README uses 'RHCL AI Gateway' and 'RHCL' throughout, but this abbreviation should be verified against the Official Red Hat Product Names List (OPL). Unauthorized abbreviations can cause editorial delays.

Suggested Fix: Verify 'RHCL' against the Official Red Hat Product Names List. If the official name is different (e.g., 'Red Hat Kuadrant'), use the full official name on first mention with trademark symbol, then use the approved short name or abbreviation from the OPL.

Requirement: PUBLISHING.md#naming-and-branding-consistency - 'Abbreviations: Ensure the product name is stylized correctly. Avoid unauthorized abbreviations'

---

Missing 'See it in action' section

Category: structure | Location: Missing between 'Detailed description' and 'Architecture diagrams'

The README does not include a 'See it in action' section, which is marked as 'Recommended' in the structure requirements. This section should provide links to videos/Arcades for users without environments.

Suggested Fix: Add a '### See it in action' subsection under 'Detailed description' with links to demo videos, Arcade experiences, or screenshots showing the solution in use. Example:

See it in action

[Link to demo video or Arcade experience]

Watch developers use AI-powered code completion in OpenShift Dev Spaces without sending code to external APIs.

Requirement: CONTRIBUTING.md#readme-structure-requirements - Order 5: 'See it in action' H3, Recommended, 'Link to videos/Arcades for users without environments'

---

ℹ️ Minor Issues (2)

Missing 'Reference' section as H2

Category: structure | Location: ## References section

The README has a 'References' section (H2) which is good, but it's marked as 'Recommended' rather than required. However, the section title uses plural 'References' instead of singular 'Reference' as shown in the structure requirements.

Suggested Fix: Consider changing '## References' to '## Reference' to match the exact structure requirements, though this is a minor consistency issue.

Requirement: CONTRIBUTING.md#readme-structure-requirements - Order 12: 'Reference' H2, Recommended

---

Architecture diagram description could be more descriptive

Category: formatting | Location: Architecture diagrams section: ![Inference traffic flow...]

The architecture diagram alt text 'Inference traffic flow from Dev Spaces through RHCL AI Gateway to llm-d and vLLM' is functional but could be enhanced to better describe the purpose and meaning for accessibility, not just literal description.

Suggested Fix: Enhance alt text to explain the meaning: 'Architecture diagram showing how developer requests flow securely from OpenShift Dev Spaces through authentication and routing layers to GPU-accelerated inference, keeping all code within the cluster boundary'

Requirement: PUBLISHING.md#content-quality - 'Alt Text: All images must have descriptive alt text that explains the function or meaning of the image, not just a literal description'

---

💡 Suggestions (1)

Consider adding AI transparency disclosure

Category: content | Location: General content review

If any part of this README or the quickstart documentation was generated using AI tools, the Publishing Guidelines recommend consulting legal about whether a disclosure is required.

Suggested Fix: If AI was used to generate any content, add an appropriate disclosure statement such as 'Portions of this documentation were assisted by AI tools' in a footer or metadata section, after consulting with legal team.

Requirement: PUBLISHING.md#legal-and-compliance - 'Disclosure: If any part of the quickstart was generated using AI, consult legal on whether a disclosure is required'

---

🤖 Automated review powered by Claude

[sarabanderby]

LGTM