LCORE-3141: devel-doc make target

[tisnik]

Description

LCORE-3141: devel-doc make target

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-3141

Summary by CodeRabbit

• Documentation
  • Updated the documented Make targets for generating documentation.
  • Added a dedicated target for generating developer documentation.
  • Existing documentation commands now use the centralized developer documentation target.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d75646a2-474d-4a5c-8c65-59435aefdbcb

📥 Commits

Reviewing files that changed from the base of the PR and between b35bce4 and 939151d.

📒 Files selected for processing (2)

• Makefile
• README.md

📜 Recent review details

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

• GitHub Check: Pyright
• GitHub Check: integration_tests (3.12)
• GitHub Check: Pylinter
• GitHub Check: build-pr
• GitHub Check: E2E: library mode / ci / group 1
• GitHub Check: E2E: server mode / ci / group 3
• GitHub Check: E2E: server mode / ci / group 2
• GitHub Check: E2E: server mode / ci / group 1
• GitHub Check: E2E: library mode / ci / group 3
• GitHub Check: E2E: library mode / ci / group 2
• GitHub Check: E2E Tests for Lightspeed Evaluation job

🧰 Additional context used

📓 Path-based instructions (1)

**/*

📄 CodeRabbit inference engine (Custom checks)

**/*: Flag meaningful O(n^2)+ algorithms on non-trivial inputs, including handlers and Kubernetes list operations.
Flag N+1 patterns that list items and then query once per item, including Kubernetes API and database access.
Flag expensive work inside loops, including API calls, JSON parsing, and regex compilation.
Flag unbounded growth in caches, watchers, or buffers when eviction or limits are missing.
Flag missing pagination or limits on list operations and API endpoints.
Flag secrets or tokens logged in plaintext or hardcoded in source.
Flag API endpoints missing authentication or authorization.
Flag injection vulnerabilities, including SQL injection, command injection, and path traversal.
Flag sensitive data leaked in API responses, WebSocket messages, or logs.
Flag Kubernetes Secrets and Red Hat secrets missing OwnerReferences.

Never commit secrets or keys; use environment variables for sensitive data.

Files:

• README.md
• Makefile

🪛 checkmake (0.3.2)

Makefile

[warning] 188-188: Target "generate-documentation" should be declared PHONY.

(phonydeclared)

---

[warning] 190-190: Target "doc" should be declared PHONY.

(phonydeclared)

🔇 Additional comments (2)

README.md (1)

921-923: LGTM!

Makefile (1)

188-193: 🎯 Functional Correctness

Declare the documentation targets as .PHONY.
generate-documentation, doc, and devel-doc should be phony so a same-named file or directory cannot skip these recipes.

---

Walkthrough

Documentation generation is centralized under a new devel-doc Make target. Existing documentation targets delegate to it, and the README lists generate-documentation, doc, and devel-doc.

Changes

Documentation target restructuring

Layer / File(s)	Summary
Documentation target wiring and README updates Makefile, README.md	generate-documentation and doc delegate to devel-doc, which runs the documentation generator; the README documents all three targets.

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

Possibly related PRs

• lightspeed-core/lightspeed-stack#2061: Updates the documented Make targets in the same README section.

Suggested reviewers: are-ces

🚥 Pre-merge checks | ✅ 5 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Performance And Algorithmic Complexity	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Security And Secret Handling	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.

✅ 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 clearly names the new devel-doc Make target and matches the main change in the PR.
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.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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