Add a sync job to push docs changes to the kitops repo

[javisperez]

This pull request introduces automation for syncing documentation changes from the kitops-ts repository to the main KitOps repository. The workflow ensures that any updates to the documentation in kitops-ts are automatically copied and a pull request is opened in the KitOps repository, streamlining the process and reducing manual effort.

Documentation sync automation:

• Added .github/workflows/docs-sync.yml to trigger a sync workflow when changes are pushed to the docs directory on the main branch.
• Added .github/workflows/sync-docs-to-kitops.yml workflow to handle the actual syncing process, including generating a GitHub App token, checking out both repositories, copying documentation files, and opening a pull request in the KitOps repository with the updated docs.

[Copilot]

Pull request overview

Adds GitHub Actions automation to sync documentation changes from kitops-ts into the main kitops-ml/kitops repository by copying docs and opening/refreshing a PR.

Changes:

• Added a push-triggered workflow that runs when docs/** changes on main.
• Added a reusable workflow that checks out both repos, copies docs into kitops/docs/kitops-ts, and opens a PR in kitops.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
.github/workflows/docs-sync.yml	Triggers the reusable sync workflow on docs/** changes to main.
.github/workflows/sync-docs-to-kitops.yml	Implements the sync logic: token creation, dual checkout, file copy, and PR creation in kitops.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[amisevsk]

I think we can just move this trigger into sync-docs-to-kitops.yml and avoid having to call it separately, not entirely sure why this job exists only to call the second job without doing anything else

[amisevsk]

Aha I see you've already changed it

[javisperez]

yes sir! thanks for the idea 🎉

[amisevsk]

E.g.

Suggested change

	on:
	workflow_call:
	secrets:
	KITOPS_BOT_PRIVATE_KEY:
	required: true
	workflow_dispatch:
	on:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	workflow_dispatch:

[amisevsk]

This can be made a tiny bit cleaner by copying both repos to separate paths (this was will put kitops-clone as a subdirectory in kitops-ts) but it's not terribly important.