-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
23 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
module.exports = { | ||
markdown: { | ||
entry: ["./README.zh-CN.md"], | ||
entryLocale: "zh-CN", | ||
entryExtension: ".zh-CN.md", | ||
outputLocales: ["en-US"], | ||
outputExtensions: (locale, { getDefaultExtension }) => { | ||
if (locale === "en-US") return ".md"; | ||
return getDefaultExtension(locale); | ||
}, | ||
}, | ||
}; |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,23 @@ | ||
# This is the Market Index of Vidol Chat | ||
# This is the Market Virtual Store Directory for Vidol.Chat | ||
|
||
[Vidol Chat](https://github.com/v-idol/vidol.chat) accesses [`index.json`] from this repo to show user the list of available agents and songs and so on. | ||
[Vidol Chat](https://github.com/v-idol/vidol.chat) displays the available product list to users by reading the `index.json` file from this repository. | ||
|
||
**English** · [简体中文](./README.zh-CN.md) | ||
|
||
## How to submit agent | ||
## How to Submit an Agent | ||
|
||
If you wish to add an agent onto the index, make an entry in `agents` directory using `agent_template.json`, write a short description then open as a pull request! | ||
If you wish to add an Agent to the list, simply add a file under the `agents` folder using the `templates/agent.json`, provide a brief description, and submit a PR to the `main` branch. | ||
|
||
### Step by step instructions | ||
### Detailed Submission Guidelines | ||
|
||
1. Fork of this repository. | ||
1. Fork this repository. | ||
|
||
2. Make a copy of `templates/agent.json` | ||
2. Make a copy of the `templates/agent.json` file. | ||
|
||
3. Fill in the copy and rename it appropriately | ||
3. Fill in the appropriate Agent configuration information. | ||
|
||
4. Move it into `agents` directory | ||
4. Move it to the `src\agents` folder. | ||
|
||
5. Submit a pull request and wait for review. | ||
5. Submit the PR, wait for review, and upon merging, the `public/agents/index.json` file will be automatically rebuilt. | ||
|
||
- Don't edit the `index.json` directly and don't modify any other files unless you have a special reason. | ||
|
||
- The `created` date will be automatically populated after merge. | ||
- The `created` field will be automatically added, please ensure the uniqueness of `agentId`. |