add root directory parameter to deploy button to make it one click

zed-wong commented 2 months ago

Type

enhancement

Description

The Vercel deployment buttons in the README now include a root-directory=interface parameter to facilitate one-click deployment directly to the specified subdirectory.

Changes walkthrough

Relevant files

Enhancement

README.md

Enhance Vercel Deployment Button with Root Directory Parameter

README.md

Added root-directory=interface parameter to the Vercel deploy button
links in the README.

+2/-2

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
mr-market	✅ Ready (Inspect)	Visit Preview	Apr 16, 2024 0:12am

railway-app[bot] commented 2 months ago

This PR is being deployed to Railway 🚅

railway-app[bot] commented 2 months ago

This PR is being deployed to Railway 🚅

Mr.Market: ◻️ REMOVED

github-actions[bot] commented 2 months ago

PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/49afe9d5e72a9cf519c3122b8926273f050979ea)

github-actions[bot] commented 2 months ago

PR Review

(Review updated until commit https://github.com/Hu-Fi/Mr.Market/commit/49afe9d5e72a9cf519c3122b8926273f050979ea)

⏱️ Estimated effort to review [1-5]	1, because the PR involves a simple enhancement by adding a parameter to existing links in the README.md file. The changes are minimal and straightforward, making the review process quick and easy.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.

github-actions[bot] commented 2 months ago

PR Code Suggestions

Category	Suggestions
Enhancement	Ensure consistent image sizes for a uniform appearance in the README. ___ Consider using consistent image sizes for deployment buttons to maintain a uniform appearance in the README. The Vercel button width has been changed from 72px to 52px, which differs from the previous and other deployment buttons. [README.md [82]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R82-R82) ```diff - + ```

Category

Suggestions

Enhancement

Ensure consistent image sizes for a uniform appearance in the README.

___ **Consider using consistent image sizes for deployment buttons to maintain a uniform
appearance in the README. The Vercel button width has been changed from 72px to 52px,
which differs from the previous and other deployment buttons.** [README.md [82]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R82-R82) ```diff -

+

```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

github-actions[bot] commented 2 months ago

PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/49afe9d5e72a9cf519c3122b8926273f050979ea)

github-actions[bot] commented 2 months ago

Persistent review updated to latest commit https://github.com/Hu-Fi/Mr.Market/commit/49afe9d5e72a9cf519c3122b8926273f050979ea

github-actions[bot] commented 2 months ago

PR Code Suggestions

Category	Suggestions
Enhancement	Add `title` attributes to deployment buttons for enhanced accessibility and user information. ___ Consider adding `title` attributes to the deployment buttons for better accessibility and to provide additional context on hover. This can improve user experience by giving users more information about what each button does before they click it. [README.md [9]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R9-R9) ```diff - + ```
Enhancement	Standardize the width of deployment buttons for visual consistency. ___ It's recommended to maintain consistent sizing for similar elements to provide a uniform user experience. The deployment buttons should have the same width to avoid visual inconsistency. [README.md [10]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R10-R10) ```diff - + ```
Accessibility	Improve the descriptiveness of `alt` attributes in image links for better accessibility. ___ Ensure that the `alt` attributes of images used in links are descriptive enough to represent the action or purpose of the link, especially for accessibility reasons. This will help screen reader users understand the function of the button without needing to see it. [README.md [9]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R9-R9) ```diff - + ```
User guidance	Add descriptive text under deployment buttons to guide users through the deployment process. ___ To enhance clarity and user guidance, consider adding a brief description or steps under each deployment button, explaining what happens when the button is clicked. This can help users understand the process and what to expect, improving the overall user experience. [README.md [82]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R82-R82) ```diff + Clicking this button will deploy the Mr. Market interface on Vercel, setting up all necessary environment variables automatically. ```
Readability	Use a list format for deployment steps to enhance document structure and readability. ___ To improve the readability and structure of the document, consider using a list format for the deployment steps instead of plain text. This can make the instructions clearer and easier to follow. [README.md [80-82]](https://github.com/Hu-Fi/Mr.Market/pull/154/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R80-R82) ```diff -1. Click button to deploy server on railway -2. Click button to deploy interface on vercel +- Click button to deploy server on railway +- Click button to deploy interface on vercel ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

Hu-Fi / Mr.Market