Improvements

[narthur]

This pull request introduces several updates across configuration, documentation, and dependency management. The key changes include adding a GitHub Actions CI workflow, updating Node.js version management, enhancing the API documentation with code examples, and modifying dependencies in pnpm-lock.yaml.

CI and Configuration Updates:

• Added a new GitHub Actions CI workflow in .github/workflows/ci.yml to check links using UmbrellaDocs/action-linkspector@v1.
• Updated Node.js version management by removing the version from .nvmrc and adding it to .tool-versions. [1] [2]

Dependency Management:

• Updated pnpm-lock.yaml to include @types/node@22.14.1 and undici-types@6.21.0 as dependencies for vite and vitepress. [1] [2] [3] [4] [5] [6]

Documentation Enhancements:

• Improved the API documentation in src/api-v1.md by replacing the example request with a code group that includes Python, JavaScript, and cURL examples.
• Simplified the introductory text for making API requests in src/api-v1.md.

Miscellaneous:

• Added a favicon link to the VitePress configuration in .vitepress/config.js.

[Copilot]

Pull Request Overview

This PR titled "Improvements" enhances the API documentation and configuration.

• Updated API docs in src/api-v1.md to streamline the introductory text and consolidate example code snippets into a code group with examples for Python, JavaScript, and cURL.
• Added a favicon link in .vitepress/config.js to improve the site's branding.

Reviewed Changes

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

File	Description
src/api-v1.md	Refined instructional text and grouped multiple language examples together.
.vitepress/config.js	Added a favicon link to the HTML head configuration.

[github-actions]

User-Visible Improvements

This PR contains 3 user-visible improvements:

1. Added a favicon to the website (Improves the visual appearance of the website in browser tabs and bookmarks)
2. Changed the text 'Before making any API requests' to 'Before making any requests'. (This change simplifies the language and makes the instructions more clear for users.)
3. Updated the API documentation to include examples in Python, JavaScript, and cURL for making requests with authentication headers. (This change makes it easier for users to understand how to use the API, especially if they are using Python, JavaScript, or cURL.)

Last updated: 2025-04-23T18:37:56.250Z