LCORE-4613: Added missing links do design documents

[tisnik]

Description

LCORE-4613: Added missing links do design documents

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library [pyproject.toml + uv.lock]
• Bump-up dependent library [requirements.*.txt for Konflux]
• 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-4613

Summary by CodeRabbit

• Documentation
  • Added links to the Widget System spike and design documents in the documentation indexes.
  • Added a “Descriptions” subsection under Models and capitalized “OGX” in a heading.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: lightspeed-core/lightspeed-stack/.coderabbit.yaml
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: b2ac99c3-4e0a-4c00-87c2-28f95ca95810

📥 Commits

Reviewing files that changed from the base of the PR and between f7523d6 and 538b91b.

📒 Files selected for processing (2)

• docs/README.md
• docs/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details

⏰ Context from checks skipped due to timeout. (25)

• GitHub Check: E2E: library / ci / default
• GitHub Check: E2E: server / ci / tls
• GitHub Check: E2E: library / ci / rbac
• GitHub Check: E2E: server / ci / other
• GitHub Check: E2E: library / ci / skills
• GitHub Check: E2E: library / ci / mcp
• GitHub Check: E2E: server / ci / default
• GitHub Check: E2E: server / ci / shields
• GitHub Check: E2E: library / ci / shields
• GitHub Check: E2E: library / ci / authorized
• GitHub Check: E2E: library / ci / other
• GitHub Check: E2E: server / ci / rbac
• GitHub Check: E2E: server / ci / mcp
• GitHub Check: E2E: server / ci / skills
• GitHub Check: E2E: server / ci / authorized
• GitHub Check: Pylinter
• GitHub Check: build-pr
• GitHub Check: unit_tests (3.12)
• GitHub Check: integration_tests (3.12)
• GitHub Check: integration_tests (3.13)
• GitHub Check: unit_tests (3.13)
• GitHub Check: Red Hat Konflux / lightspeed-stack-0-8-e2e-tests / lightspeed-stack-0-8
• GitHub Check: Red Hat Konflux / rag-content-0-8-e2e-tests / lightspeed-stack-0-8
• GitHub Check: Red Hat Konflux / lightspeed-core-0-8-enterprise-contract / lightspeed-stack-0-8
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-8-on-pull-request

⚠️ CI failures not shown inline (1)

GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-8-on-pull-request: pipelinerun start failure

Conclusion: failure

View job details

Konflux kflux-prd-rh02/lightspeed-stack-0-8-on-pull-request has <b>failed</b>.
There was an error creating the PipelineRun: <b>lightspeed-stack-0-8-on-pull-request-</b>
cannot use the API on the provider platform to create a in_progress status: PATCH https://api.github.com/repos/lightspeed-core/lightspeed-stack/check-runs/113387555344: 404 Not Found []

🧰 Additional context used

🪛 markdownlint-cli2 (0.23.3)

docs/README.md

[warning] 188-188: Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

docs/index.md

[warning] 179-179: Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

---

[warning] 195-195: Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

---

Walkthrough

The documentation indexes add links to the Widget System Spike and Design documents. The Models section gains a “Descriptions” subsection, and an “ogx” heading changes to “OGX.”

Changes

Documentation index updates

Layer / File(s)	Summary
Add Widget System documentation links docs/README.md, docs/index.md	The documentation indexes link to the Widget System Spike and Design documents. The Models section gains a “Descriptions” subsection. The OGX config merge heading uses “OGX” capitalization.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: asimurka

Merge Risk: ⚪ Minimal · up to 538b9

The new documentation links resolve, and the index edits show no material issue. The change is ready for normal checks.

🚥 Pre-merge checks | ✅ 7

✅ Passed checks (7 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding missing links to design documents. It contains a minor typo, “do” instead of “to,” but remains understandable and specific.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Performance And Algorithmic Complexity	✅ Passed	PASS — The pull request changes only Markdown documentation indexes. It adds links and changes a heading’s capitalization; it introduces no algorithms, loops, API or database calls, list operations, c…
Security And Secret Handling	✅ Passed	PASSED. The pull request changes only docs/README.md and docs/index.md. The changes add documentation links and capitalize an existing heading. They do not add secrets, tokens, API endpoints, auth…

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Create a new PR

✨ Simplify code

• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}