Skip to content

LCORE-1649: LTS process overview#1950

Merged
tisnik merged 1 commit into
lightspeed-core:mainfrom
tisnik:lcore-1649-lts-overview
Jun 19, 2026
Merged

LCORE-1649: LTS process overview#1950
tisnik merged 1 commit into
lightspeed-core:mainfrom
tisnik:lcore-1649-lts-overview

Conversation

@tisnik

@tisnik tisnik commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Description

LCORE-1649: LTS process overview

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-1649

Summary by CodeRabbit

Documentation

  • Added new "Container Orchestration Guide" documentation link
  • Added comprehensive "Long-Term Support (LTS) Process Overview" guide with detailed runbook, including process steps, roles, responsibilities, branching strategies, CI/CD requirements, and rollback procedures
  • Updated documentation index with new guide links

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@tisnik, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 41 minutes and 52 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4472a012-6a5f-4fcd-8778-67e6d6a78790

📥 Commits

Reviewing files that changed from the base of the PR and between aac3131 and bf9f18d.

📒 Files selected for processing (3)
  • docs/README.md
  • docs/index.md
  • docs/lts_flow.md

Walkthrough

Adds a new docs/lts_flow.md document covering the end-to-end LTS process, runbooks, branching strategy, CI/CD gates, rollback procedures, communication templates, and an embedded SVG flow diagram. Two navigation entries are added to docs/README.md and one to docs/index.md linking to this new page.

Changes

LTS Documentation

Layer / File(s) Summary
Navigation links in docs index files
docs/README.md, docs/index.md
Inserts a "Container Orchestration Guide" link under "Installation and configuration" in README.md, and an "LTS provess overview" link under "Releasing" in both README.md and index.md.
New LTS process and runbook document
docs/lts_flow.md
Adds 753 lines covering the LTS process overview (goals, roles, modular components, decision policies, branching/versioning, CI/CD gates, rollback/emergency procedures, communication templates, observability, automation), an embedded printable SVG flow diagram alongside copied prompt/response transcript lines, and a full "LTS Process & Runbook" section with concise runbooks, example workflow, implementation checklist, and glossary/FAQ.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • lightspeed-core/lightspeed-stack#1738: Updates the same docs/README.md and docs/index.md navigation by adding "Releasing" documentation links, directly adjacent to where the LTS overview link is inserted.
  • lightspeed-core/lightspeed-stack#1845: Modifies the same docs navigation entries in docs/README.md and docs/index.md to add the "Container Orchestration Guide" link also inserted by this PR.
  • lightspeed-core/lightspeed-stack#1928: Updates the "Releasing" navigation section in docs/README.md and docs/index.md by adding a release-process related link, the same location where the LTS overview link is added here.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly aligns with the primary change: adding LTS process overview documentation. It references the issue ticket (LCORE-1649) and clearly identifies the main focus as the LTS process overview, which is reflected across all modified files (README.md, index.md, and the new lts_flow.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/lts_flow.md`:
- Around line 240-249: Remove all internal conversation transcript fragments
from the documentation file to ensure only polished final content is published.
Specifically, delete all lines containing the meta-narrative markers such as
"User prompt", "GPT-5 mini:", and separator lines (----) that appear before and
after the SVG code block. The SVG diagram itself starting with the XML
declaration should remain intact. Search through the file and remove these
conversation context lines while preserving the actual technical content and
diagrams that follow them.
- Line 1: The markdown document violates linting rules MD022 (blank lines around
headings) and MD001 (heading hierarchy). Add a blank line immediately before
each heading in the document to comply with MD022, and change the first heading
from ### to ## to ensure proper heading level increment from top-level to
sub-level (fixing MD001). Apply these corrections to all headings mentioned: the
first heading at line 45 and all subsequent headings at lines 51, 63, 73, 141,
147, 161, 168, 176, 182, 187, 193, 200, 209, 221, 418 and any others throughout
the document that follow the same pattern.

In `@docs/README.md`:
- Line 86: The link text contains a spelling error where "provess" should be
"process". In the navigation link "LTS provess overview", correct the misspelled
word "provess" to "process" so it reads "LTS process overview". This same typo
correction needs to be applied in both docs/README.md and docs/index.md files to
ensure consistency across documentation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0abb2f82-ec73-4ca0-a618-f9153464bb27

📥 Commits

Reviewing files that changed from the base of the PR and between 1f7d8ac and aac3131.

📒 Files selected for processing (3)
  • docs/README.md
  • docs/index.md
  • docs/lts_flow.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: build-pr
  • GitHub Check: integration_tests (3.13)
  • GitHub Check: E2E: server mode / ci / group 3
  • GitHub Check: E2E: library mode / ci / group 2
  • GitHub Check: E2E: server mode / ci / group 2
  • GitHub Check: E2E: library mode / ci / group 1
  • GitHub Check: E2E: library mode / ci / group 3
  • GitHub Check: E2E Tests for Lightspeed Evaluation job
  • GitHub Check: E2E: server mode / ci / group 1
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-6-on-pull-request
🧰 Additional context used
🪛 LanguageTool
docs/index.md

[grammar] ~93-~93: Ensure spelling is correct
Context: .../lightspeed-stack/releasing.html) [LTS provess overview](https://lightspeed-core.githu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/README.md

[grammar] ~86-~86: Ensure spelling is correct
Context: .../lightspeed-stack/releasing.html) [LTS provess overview](https://lightspeed-core.githu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/lts_flow.md

[grammar] ~1-~1: Ensure spelling is correct
Context: # LTS Process Overview A modular, maintainable process for Long...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~59-~59: Ensure spelling is correct
Context: ...8. Post-release verification & rollback plan 9. Communication & documentation 10. Postm...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~60-~60: Ensure spelling is correct
Context: ...tion & rollback plan 9. Communication & documentation 10. Postmortem and metrics ## Roles & Resp...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~74-~74: Ensure spelling is correct
Context: ...mponents (for implementation) 1. Intake Module - Inputs: user issue report (bug, CVE, fe...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~81-~81: Ensure spelling is correct
Context: ... system API, email, webhook. 2. Triage Module - Inputs: ticket. - Outputs: priority,...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~89-~89: Ensure spelling is correct
Context: ...lease calendar. 3. Planning & Approval Module - Inputs: triage decision, risk score. ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~95-~95: Ensure spelling is correct
Context: ...ranch names, milestone. 4. Development Module - Inputs: backport plan, target branches....

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~103-~103: Ensure spelling is correct
Context: ...review system. 5. Testing & Validation Module - Inputs: merge request/PR. - Outputs:...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~111-~111: Ensure spelling is correct
Context: ...nment provisioning. 6. Release Staging Module - Inputs: merged patches in LTS branches....

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~119-~119: Ensure spelling is correct
Context: ...ge registries. 7. Release & Deployment Module - Inputs: RC approval. - Outputs: publ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~127-~127: Ensure spelling is correct
Context: ...ries. 8. Communication & Documentation Module - Inputs: release artifacts, changelog, s...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~134-~134: Ensure spelling is correct
Context: ...al channels. 9. Post-release & Metrics Module - Inputs: deployment telemetry, incident ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~152-~152: Ensure spelling is correct
Context: ... CVE ID (if applicable) - Repro Steps + Testcase - Proposed patch branch - Target LTS bran...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~154-~154: Ensure spelling is correct
Context: ...se - Proposed patch branch - Target LTS branches - Triage owner & date - Estimated effort ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~155-~155: Ensure spelling is correct
Context: ... - Target LTS branches - Triage owner & date - Estimated effort - Approvals (list with...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~156-~156: Ensure spelling is correct
Context: ...nches - Triage owner & date - Estimated effort - Approvals (list with timestamps) - Rele...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~166-~166: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s relevant. - Tagging: vX.Y.Z-lts or vX.Y.Z (use stable, consistent tags); includ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[grammar] ~170-~170: Ensure spelling is correct
Context: ...have) - Lint + static analysis - Unit + integration - Backport-specific regression suite - Security sc...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~171-~171: Ensure spelling is correct
Context: ...egration - Backport-specific regression suite - Security scan (dependency, SAST) - Artifact sign...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~187-~187: Ensure spelling is correct
Context: ...s, rollback status. ## Observability & Auditing - Log every state transition for ticket (...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~222-~222: Ensure spelling is correct
Context: ...ucture (for the final doc) 1. Purpose & scope 2. Roles & responsibilities 3. End-to-end ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~223-~223: Ensure spelling is correct
Context: ...inal doc) 1. Purpose & scope 2. Roles & responsibilities 3. End-to-end flow diagram (visual) 4. Det...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~234-~234: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...& emergency drills 12. Glossary & FAQs If you want, I can produce: - A printable flow diag...

(IF_YOU_WANT)


[grammar] ~415-~415: Ensure spelling is correct
Context: ...nerate the document as described above, please GPT-5 mini: ## LTS Process & Runbook ##...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~436-~436: Ensure spelling is correct
Context: ...icy changes. ### High-level end-to-end flow 1. Intake (ticket created/enriched) 2. Tri...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~468-~468: Ensure spelling is correct
Context: ...## Detailed module descriptions Intake Module - Purpose: standardize incoming reports a...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~480-~480: Ensure spelling is correct
Context: ...ds (CVE, security, regression). Triage Module - Purpose: quickly determine impact, scop...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~491-~491: Ensure spelling is correct
Context: .../medium/large) - Security flag set if relevant - Artefacts: triage comment, labels, dead...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~494-~494: Ensure spelling is correct
Context: ... labels, deadline. Planning & Approval Module - Purpose: create an actionable backport ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~508-~508: Ensure spelling is correct
Context: ...se Manager for fast-track. Development Module - Purpose: implement minimal, safe patch ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~521-~521: Ensure spelling is correct
Context: ...ackport branches. Testing & Validation Module - Purpose: ensure patch correctness and a...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~535-~535: Ensure spelling is correct
Context: ...producer if available. Release Staging Module - Purpose: produce reproducible artifacts...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~547-~547: Ensure spelling is correct
Context: ...h immutable tags. Release & Deployment Module - Purpose: publish artifacts to LTS chann...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~576-~576: Ensure spelling is correct
Context: ...t if necessary. Post-release & Metrics Module - Purpose: verify release success and col...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~644-~644: Ensure spelling is correct
Context: ...d versions: list - Impact: brief impact summary - Mitigation: upgrade instructions or ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~645-~645: Ensure spelling is correct
Context: ...y - Mitigation: upgrade instructions or workaround - Contact: security@your-org.example -...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~654-~654: Ensure spelling is correct
Context: ...ta model (fields) - Ticket ID - Title & description - Reporter & contact - Affected versions ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~655-~655: Ensure spelling is correct
Context: ...t ID - Title & description - Reporter & contact - Affected versions (list) - Severity (en...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~659-~659: Ensure spelling is correct
Context: ...ID (if applicable) - Repro steps + test case - Proposed patch branch names - Target LT...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~661-~661: Ensure spelling is correct
Context: ...roposed patch branch names - Target LTS branches - Triage owner & date - Estimated effort ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~662-~662: Ensure spelling is correct
Context: ... - Target LTS branches - Triage owner & date - Estimated effort - Approvals (list with...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~663-~663: Ensure spelling is correct
Context: ...nches - Triage owner & date - Estimated effort - Approvals (list with timestamps and rol...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~666-~666: Ensure spelling is correct
Context: ...ersions & artifact IDs - Build manifest link - Post-release notes & metrics ### Obser...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~669-~669: Ensure spelling is correct
Context: ...se notes & metrics ### Observability & auditing - Record all ticket state transitions, ap...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~692-~692: Ensure spelling is correct
Context: ...y flag if needed. Backport development runbook 1. Create branch lts/vX.Y/issue-. 2. I...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~708-~708: Ensure spelling is correct
Context: ...pdate ticket and communicate. Rollback runbook 1. Detect failure via monitoring or alerts...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~715-~715: Ensure spelling is correct
Context: ...ent and trigger postmortem. Postmortem runbook 1. Gather timeline from ticket and logs. 2...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~731-~731: Ensure spelling is correct
Context: ...et, update metrics. ### Implementation checklist - Create issue templates and ticket field...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.22.1)
docs/lts_flow.md

[warning] 45-45: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)


[warning] 45-45: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 51-51: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 63-63: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 141-141: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 147-147: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 161-161: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 168-168: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 176-176: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 182-182: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 187-187: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 193-193: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 200-200: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 209-209: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 221-221: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 250-250: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)


[warning] 418-418: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)


[warning] 420-420: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 423-423: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 436-436: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 448-448: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 589-589: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 599-599: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 615-615: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 652-652: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 669-669: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 675-675: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 722-722: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 731-731: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


[warning] 742-742: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🔇 Additional comments (1)
docs/lts_flow.md (1)

250-250: 💤 Low value

Verify code block style preference.

Line 250 uses a fenced code block (```svg) for the SVG diagram. Markdownlint (MD046) suggests the project may prefer indented code blocks. Confirm whether the fenced style is acceptable for this multi-line SVG, or if the project style guide requires indentation.

Comment thread docs/lts_flow.md
@@ -0,0 +1,753 @@
# LTS Process Overview

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Add blank lines around headings to comply with markdown style conventions.

The document violates the project's markdown style rules (markdownlint MD022 and MD001). Specifically:

  • Line 45: First heading is ### before any ## (heading increment issue).
  • Lines 45, 51, 63, 73, 141, 147, 161, 168, 176, 182, 187, 193, 200, 209, 221, 418, etc.: Missing blank line before heading.

Add a blank line above each heading and ensure heading levels increment by one (e.g., ######, not skip directly to ###).

The fix is straightforward: insert blank lines before each heading and adjust the first heading from ### to ## if the TOC structure intends it as a top-level section within the document.

Also applies to: 45-45, 51-51, 63-63, 73-73, 141-141, 147-147, 161-161, 168-168, 176-176, 182-182, 187-187, 193-193, 200-200, 209-209, 221-221, 418-418

🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: Ensure spelling is correct
Context: # LTS Process Overview A modular, maintainable process for Long...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/lts_flow.md` at line 1, The markdown document violates linting rules
MD022 (blank lines around headings) and MD001 (heading hierarchy). Add a blank
line immediately before each heading in the document to comply with MD022, and
change the first heading from ### to ## to ensure proper heading level increment
from top-level to sub-level (fixing MD001). Apply these corrections to all
headings mentioned: the first heading at line 45 and all subsequent headings at
lines 51, 63, 73, 141, 147, 161, 168, 176, 182, 187, 193, 200, 209, 221, 418 and
any others throughout the document that follow the same pattern.

Comment thread docs/lts_flow.md Outdated
Comment on lines +240 to +249
--------------------

User prompt 2 of 4 - 6/18/2026, 8:50:12 AM:
provide printable flow diagram with svg

GPT-5 mini:
Below is an SVG flow diagram you can save as a .svg file and print. It shows the LTS process flow (intake → triage → planning & approval → development → testing & validation → release staging → release & deployment → communication & post-release). Each node includes owner and key outputs.

Save the entire output below into a file named lts-process.svg.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Remove conversation transcript from documentation.

Lines 240–249, 404–412, and 414–417 contain meta-narrative fragments from an AI conversation ("User prompt 2 of 4", "GPT-5 mini:", etc.). These are internal development notes—not content for published documentation. Readers should not see how the document was generated; the final polished documentation should begin at line 1 and proceed directly through the process overview and runbook sections.

Remove all lines containing "User prompt", "GPT-5 mini:", and the separators (----) that frame these exchanges. The SVG code block (lines 250–402) should remain, but its surrounding conversation context must be deleted.

🗑️ Suggested cleanup

Delete lines 240–249:

---------------------
-
-User prompt 2 of 4 - 6/18/2026, 8:50:12 AM:
-provide printable flow diagram with svg
-
-GPT-5 mini:
-Below is an SVG flow diagram you can save as a .svg file and print. It shows the LTS process flow (intake → triage → planning & approval → development → testing & validation → release staging → release & deployment → communication & post-release). Each node includes owner and key outputs.
-
-Save the entire output below into a file named lts-process.svg.
-

Delete lines 404–412:

---------------------
-
-User prompt 3 of 4 - 6/18/2026, 8:52:53 AM:
-thank you
-
-GPT-5 mini:
-You're welcome.
-
----------------------
-

Delete lines 414–417:

-User prompt 4 of 4 - 6/19/2026, 9:04:30 AM:
-generate the document as described above, please
-
-GPT-5 mini:

The SVG block (lines 250–402, starting with <?xml) remains in place after cleanup.

Also applies to: 404-412, 414-417

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/lts_flow.md` around lines 240 - 249, Remove all internal conversation
transcript fragments from the documentation file to ensure only polished final
content is published. Specifically, delete all lines containing the
meta-narrative markers such as "User prompt", "GPT-5 mini:", and separator lines
(----) that appear before and after the SVG code block. The SVG diagram itself
starting with the XML declaration should remain intact. Search through the file
and remove these conversation context lines while preserving the actual
technical content and diagrams that follow them.

Comment thread docs/README.md

[Releasing](https://lightspeed-core.github.io/lightspeed-stack/releasing.html)

[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix spelling error in navigation link.

Line 86 contains "LTS provess overview" but should read "LTS process overview". This same typo appears in docs/index.md line 93 and must be corrected in both locations.

✏️ Proposed fix for both files

In docs/README.md line 86:

-[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
+[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)

In docs/index.md line 93:

-[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
+[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
🧰 Tools
🪛 LanguageTool

[grammar] ~86-~86: Ensure spelling is correct
Context: .../lightspeed-stack/releasing.html) [LTS provess overview](https://lightspeed-core.githu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/README.md` at line 86, The link text contains a spelling error where
"provess" should be "process". In the navigation link "LTS provess overview",
correct the misspelled word "provess" to "process" so it reads "LTS process
overview". This same typo correction needs to be applied in both docs/README.md
and docs/index.md files to ensure consistency across documentation.

@tisnik tisnik force-pushed the lcore-1649-lts-overview branch from aac3131 to bf9f18d Compare June 19, 2026 07:21
@tisnik tisnik merged commit bcc47ed into lightspeed-core:main Jun 19, 2026
31 of 32 checks passed
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.

1 participant