docs(ci): add documentation explaining CI workflow structure

[tomsebastian10]

Summary

This PR improves the documentation and clarity of the main CI reusable workflow (ci.yml).

It adds:

• A high-level explanation of the CI pipeline
• Inline comments describing each job
• Clearer understanding of the workflow structure for contributors

Motivation

The CI workflow is a central part of the urunc development process, but new contributors may find it difficult to understand how the different jobs (linting, build, unit tests, E2E tests, Kubernetes tests) are connected.

Improving inline documentation makes the CI pipeline easier to understand and helps contributors quickly identify:

• What each job does
• When jobs are executed
• How jobs depend on one another

This change does not modify CI behavior — it only improves readability and maintainability.

Changes

• Added top-level documentation comment explaining the workflow
• Added inline comments describing each job's purpose
• Improved clarity without altering execution logic

Testing

No functional changes were introduced.
The workflow behavior remains unchanged.

---

Please let me know if any additional clarification would be helpful.

[netlify]

✅ Deploy Preview for urunc ready!

Name	Link
🔨 Latest commit	79a1ce0
🔍 Latest deploy log	https://app.netlify.com/projects/urunc/deploys/69933f8a6963d8000810fa38
😎 Deploy Preview	https://deploy-preview-485--urunc.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[cmainas]

Hello @tomsebastian10 ,

thank you for your PR. While comments are always useful, I am not sure why the README should contain information about the CI. Also, please read and follow the contribution guide.

[tomsebastian10]

Hello @tomsebastian10 ,

thank you for your PR. While comments are always useful, I am not sure why the README should contain information about the CI. Also, please read and follow the contribution guide.

Hi @cmainas,

Thank you for pointing that out.

I will remove the CI section from the README and instead place the documentation under the appropriate location in the /docs directory, following the contribution guide.

I will also open an issue first as required and reference it in the PR.

Thanks for the guidance!