docs: contributing templates (#8042)
* sidebars * docs: add templates submission page * Apply suggestions from code review * style-cleanup * include-items * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * add-links * link-to-anchor --------- Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
This commit is contained in:
parent
67ffea984d
commit
cddf2e13f0
2 changed files with 85 additions and 0 deletions
84
docs/docs/Contributing/contributing-templates.md
Normal file
84
docs/docs/Contributing/contributing-templates.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
title: Contribute templates
|
||||
slug: /contributing-templates
|
||||
---
|
||||
|
||||
Follow these best practices when submitting a template to Langflow.
|
||||
|
||||
For template formatting examples, see the Langflow repository's [starter_projects](https://github.com/langflow-ai/langflow/tree/main/src/backend/base/langflow/initial_setup/starter_projects) folder.
|
||||
|
||||
## Create a PR to submit your template
|
||||
|
||||
Follow these steps to submit your template:
|
||||
|
||||
1. Fork the [Langflow repository](https://github.com/langflow-ai/langflow) on GitHub.
|
||||
2. Add your `template.json` file to the Langflow repository's [starter_projects](https://github.com/langflow-ai/langflow/tree/main/src/backend/base/langflow/initial_setup/starter_projects) folder in your fork.
|
||||
3. Include the [Required items for template submission](#required-items-for-template-submission) listed below.
|
||||
4. Create a Pull Request from your fork to the main Langflow repository.
|
||||
5. Include a screenshot of your template in the PR.
|
||||
|
||||
The Langflow team will review your PR, offer feedback, and merge the template.
|
||||
|
||||
## Required items for template submission
|
||||
|
||||
Include the following items and follow these guidelines when submitting your template.
|
||||
|
||||
### Name
|
||||
The template name must be concise and contain no more than three words.
|
||||
Capitalize only the first letter of each word.
|
||||
For example: **Blog Writer** or **Travel Planning Agent**.
|
||||
|
||||
### Description
|
||||
The description is displayed in the UI to guide users to your template.
|
||||
The description should be brief and informative, and describe what the template does and its intended use cases.
|
||||
For example:```json "description": "Auto-generate a customized blog post from instructions and referenced articles.",```
|
||||
|
||||
### Icons
|
||||
|
||||
Use icons from the [Lucide](https://lucide.dev/icons/) icon library.
|
||||
|
||||
### Flow
|
||||
Use only the components that are available in the sidebar.
|
||||
Do not use custom components.
|
||||
|
||||
Include a note to guide users. Notes accept Markdown syntax.
|
||||
A single note usually suffices.
|
||||
|
||||
For example:
|
||||
```text
|
||||
# Financial Assistant Agents
|
||||
|
||||
The Financial Assistant Agent retrieves web content and writes reports about finance.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* [OpenAI API Key](https://platform.openai.com/)
|
||||
* [Tavily AI Search key](https://docs.tavily.com/welcome)
|
||||
* [Sambanova API key](https://sambanova.ai/)
|
||||
|
||||
## Quickstart
|
||||
|
||||
1. In both **Agent** components, add your OpenAI API key.
|
||||
2. In the **Model Provider** field, select **Sambanova**, and select a model.
|
||||
3. In the **Sambanova** component, add your **Sambanova API key**.
|
||||
4. In the **Tavily Search** component, add your **Tavily API key**.
|
||||
5. Click the **Playground** and ask `Why did Nvidia stock drop in January?`
|
||||
```
|
||||
|
||||
### Format
|
||||
|
||||
Submit the template in JSON format.
|
||||
|
||||
### Tags
|
||||
Assign the template to one of the following categories:
|
||||
|
||||
- Assistants
|
||||
- Classification
|
||||
- Coding
|
||||
- Content Generation
|
||||
- Q&A
|
||||
- Prompting
|
||||
- RAG
|
||||
- Agents
|
||||
|
||||
For more information, see the Langflow repository's [template categories](https://github.com/langflow-ai/langflow/blob/main/src/frontend/src/modals/templatesModal/index.tsx#L27-L57).
|
||||
|
|
@ -260,6 +260,7 @@ module.exports = {
|
|||
"Contributing/contributing-how-to-contribute",
|
||||
"Contributing/contributing-components",
|
||||
"Contributing/contributing-component-tests",
|
||||
"Contributing/contributing-templates",
|
||||
"Contributing/contributing-bundles",
|
||||
"Contributing/contributing-github-discussion-board",
|
||||
"Contributing/contributing-github-issues",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue