Updates to the docs

[javisperez]

This pull request updates the documentation for the kitops-ts TypeScript SDK, focusing on improving clarity, usability, and accuracy. The main changes include updating example code to be more robust, correcting documentation paths, and cleaning up outdated or redundant content.

Documentation improvements:

• Updated the example in docs/examples.md to generate a Kitfile only if it doesn't exist, use environment variables for configuration, and handle login/logout more robustly. This makes the example more production-ready and user-friendly. [1] [2]
• Changed the KitOps CLI installation link in docs/getting-started.md to use a relative path, ensuring the link works correctly in the documentation site.
• Cleaned up the main docs/index.md by removing badges and an outdated contributing link, resulting in a more focused introduction. [1] [2]

API reference and workflow updates:

• Removed redundant type definitions and documentation from docs/api-reference.md, likely to reduce duplication and keep the API reference concise.
• Updated the KITOPS_TS_DOCS_PATH in .github/workflows/docs-sync.yml to reflect the new documentation directory structure, ensuring CI/CD workflows point to the correct location.

[Copilot]

Pull request overview

This PR updates the kitops-ts documentation to improve clarity and reduce duplication, including moving type docs into a dedicated page and refining examples and navigation.

Changes:

• Added a new docs/types.md page to document exported TypeScript types (and removed redundant type docs from docs/api-reference.md).
• Updated docs/examples.md with a more “production-like” workflow (Kitfile generation, env-based config, and logout in finally).
• Cleaned up docs navigation/content and adjusted docs sync workflow pathing.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
docs/types.md	New consolidated type documentation page (needs link/anchor and type-shape accuracy fixes).
docs/index.md	Removes badges and contributing link; docs nav text now needs to reflect the new Types page.
docs/getting-started.md	Changes KitOps CLI installation link to a relative site path.
docs/examples.md	More robust example, but currently can break when env vars/workdir are missing.
docs/api-reference.md	Removes redundant Types section; kit() example now needs to match actual function signature.
.github/workflows/docs-sync.yml	Updates destination docs path for sync into the kitops repo.

---

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