Update readme for developers using Yext platform #103
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR significantly expands the README.md file to provide comprehensive documentation for developers using the Yext JavaScript/TypeScript SDK monorepo. The update transforms a minimal 2-line README into a detailed developer guide with 122 lines of structured documentation.
Key Changes:
- Added complete project overview and structure documentation
- Included setup instructions and usage examples for developers
- Added contributing guidelines and licensing information
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| ## Overview | ||
|
|
||
| This repository is a monorepo housing Yext’s JavaScript and TypeScript SDKs—designed to streamline integrations with Yext’s platform. If you're looking to leverage Yext functionalities such as Search, Chat, Pages, Analytics, or Listings in your JavaScript/TypeScript project, you’ve come to the right place. | ||
| ([github.com](https://github.com/yext/js?utm_source=chatgpt.com)) |
There was a problem hiding this comment.
The UTM source parameter 'chatgpt.com' appears inappropriate for a GitHub README. This suggests the content was generated or copied from ChatGPT. Consider removing the UTM parameter or using a more appropriate source identifier.
| ([github.com](https://github.com/yext/js?utm_source=chatgpt.com)) | |
| ([github.com](https://github.com/yext/js)) |
| ## Overview | ||
|
|
||
| This repository is a monorepo housing Yext’s JavaScript and TypeScript SDKs—designed to streamline integrations with Yext’s platform. If you're looking to leverage Yext functionalities such as Search, Chat, Pages, Analytics, or Listings in your JavaScript/TypeScript project, you’ve come to the right place. | ||
| ([github.com](https://github.com/yext/js?utm_source=chatgpt.com)) |
There was a problem hiding this comment.
The link text 'github.com' is redundant since this README will be displayed on the same GitHub repository. Consider removing this link entirely or replacing it with more meaningful content.
| ([github.com](https://github.com/yext/js?utm_source=chatgpt.com)) |
| ``` | ||
| yext/js/ | ||
| ├── apps/ # Example/demo applications and test sandboxes | ||
| ├── packages/ # Individual SDKs (e.g., search-core, chat-core, search-headless) |
There was a problem hiding this comment.
This repo only contains pages-components which provides common/core component functionality that's useful for Pages React development. The other SDKs listed are in their own repos.
There was a problem hiding this comment.
@mkilpatrick can you give me input on what you'd like changed? As a dev for larger company looking for js component github, the no readme situation was meh, so would like to start by updating.
2 participants
Have to do implementation for clients and need documentation in repos. Updating with PR -- let me know if anything else helps.