jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: add styling with admonitions

Browse source
This commit is contained in:
Cezar Vasconcelos 2024-05-23 17:59:31 -03:00
commit 9fbac00ea2
8 changed files with 13 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/integrations/notion/add-content-to-page.md
View file

@ -115,7 +115,7 @@ In this example, the `AddContentToPage` component connects to a `MarkdownLoader`
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `AddContentToPage` component: When using the `AddContentToPage` component:
@ -123,7 +123,6 @@ When using the `AddContentToPage` component:
- Verify the `block_id` corresponds to the right Notion page/block. - Verify the `block_id` corresponds to the right Notion page/block.
- Keep your Notion integration token secure. - Keep your Notion integration token secure.
- Test with sample markdown text before production use. - Test with sample markdown text before production use.
</Admonition>
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">

7
docs/docs/integrations/notion/list-database-properties.md
View file

@ -94,16 +94,13 @@ style={{ width: "100%", margin: "20px 0" }}
In this example, the `NotionDatabaseProperties` component retrieves the properties of a Notion database, and the retrieved properties are then used as input for subsequent components in the flow. In this example, the `NotionDatabaseProperties` component retrieves the properties of a Notion database, and the retrieved properties are then used as input for subsequent components in the flow.
</Admonition> </Admonition>
## Best Practices ## Best Pratices
<Admonition type="tip" title="Best Practices">
When using the `NotionDatabaseProperties` component, consider the following best practices: When using the `NotionDatabaseProperties` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to access the desired database. - Ensure that you have a valid Notion integration token with the necessary permissions to access the desired database.
- Double-check the database ID to avoid retrieving properties from the wrong database. - Double-check the database ID to avoid retrieving properties from the wrong database.
- Handle potential errors gracefully by checking the response status and providing appropriate error messages. - Handle potential errors gracefully by checking the response status and providing appropriate error messages.
</Admonition>
## Troubleshooting
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">
If you encounter any issues while using the `NotionDatabaseProperties` component, consider the following: If you encounter any issues while using the `NotionDatabaseProperties` component, consider the following:

3
docs/docs/integrations/notion/list-pages.md
View file

@ -157,14 +157,13 @@ In this example, the `NotionListPages
` component is used to retrieve specific pages from a Notion database based on the provided filters and sorting options. The retrieved data can then be processed further in the subsequent components of the flow. ` component is used to retrieve specific pages from a Notion database based on the provided filters and sorting options. The retrieved data can then be processed further in the subsequent components of the flow.
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `NotionListPages When using the `NotionListPages
` component, consider the following best practices: ` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to query the desired database. - Ensure that you have a valid Notion integration token with the necessary permissions to query the desired database.
- Construct the `query_payload` JSON string carefully, following the Notion API documentation for filtering and sorting options. - Construct the `query_payload` JSON string carefully, following the Notion API documentation for filtering and sorting options.
</Admonition>
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">
If you encounter any issues while using the `NotionListPages` component, consider the following: If you encounter any issues while using the `NotionListPages` component, consider the following:

4
docs/docs/integrations/notion/list-users.md
View file

@ -107,12 +107,12 @@ Here's an example of how you can use the `NotionUserList` component in a Langflo
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `NotionUserList` component, consider the following best practices: When using the `NotionUserList` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to retrieve user data. - Ensure that you have a valid Notion integration token with the necessary permissions to retrieve user data.
- Handle the retrieved user data securely and in compliance with Notion's API usage guidelines. - Handle the retrieved user data securely and in compliance with Notion's API usage guidelines.
</Admonition>
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">

4
docs/docs/integrations/notion/page-content-viewer.md
View file

@ -121,13 +121,13 @@ Here's an example of how you can use the `NotionPageContent` component in a Lang
/> />
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `NotionPageContent` component, consider the following best practices: When using the `NotionPageContent` component, consider the following best practices:
- Ensure that you have the necessary permissions to access the Notion page you want to retrieve. - Ensure that you have the necessary permissions to access the Notion page you want to retrieve.
- Keep your Notion integration token secure and avoid sharing it publicly. - Keep your Notion integration token secure and avoid sharing it publicly.
- Be mindful of the content you retrieve and ensure that it aligns with your intended use case. - Be mindful of the content you retrieve and ensure that it aligns with your intended use case.
</Admonition>
<Admonition type="tip" title="Troubleshooting"> <Admonition type="tip" title="Troubleshooting">
If you encounter any issues while using the `NotionPageContent` component, consider the following: If you encounter any issues while using the `NotionPageContent` component, consider the following:

6
docs/docs/integrations/notion/page-create.md
View file

@ -111,17 +111,13 @@ Here's an example of how to use the `NotionPageCreator` component in a Langflow
## Best Practices ## Best Practices
<Admonition type="tip" title="Best Practices">
When using the `NotionPageCreator` component, consider the following best practices: When using the `NotionPageCreator` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to create pages in the specified database. - Ensure that you have a valid Notion integration token with the necessary permissions to create pages in the specified database.
- Properly format the `properties` input as a JSON string, matching the structure and field types of your Notion database. - Properly format the `properties` input as a JSON string, matching the structure and field types of your Notion database.
- Handle any errors or exceptions that may occur during the page creation process and provide appropriate error messages. - Handle any errors or exceptions that may occur during the page creation process and provide appropriate error messages.
- To avoid the hassle of messing with JSON, we recommend using the LLM to create the JSON for you as input. - To avoid the hassle of messing with JSON, we recommend using the LLM to create the JSON for you as input.
</Admonition>
## Troubleshooting
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">
If you encounter any issues while using the `NotionPageCreator` component, consider the following: If you encounter any issues while using the `NotionPageCreator` component, consider the following:
- Double-check that the `database_id` and `notion_secret` inputs are correct and valid. - Double-check that the `database_id` and `notion_secret` inputs are correct and valid.

4
docs/docs/integrations/notion/page-update.md
View file

@ -116,13 +116,13 @@ Here's an example of how to use the `NotionPageUpdate` component in a Langflow f
/> />
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `NotionPageUpdate` component, consider the following best practices: When using the `NotionPageUpdate` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to update page properties. - Ensure that you have a valid Notion integration token with the necessary permissions to update page properties.
- Handle edge cases and error scenarios gracefully, such as invalid JSON format for properties or API request failures. - Handle edge cases and error scenarios gracefully, such as invalid JSON format for properties or API request failures.
- We recommend using an LLM to generate the inputs for this component, to allow flexibilty - We recommend using an LLM to generate the inputs for this component, to allow flexibilty
</Admonition>
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">
If you encounter any issues while using the `NotionPageUpdate` component, consider the following: If you encounter any issues while using the `NotionPageUpdate` component, consider the following:

4
docs/docs/integrations/notion/search.md
View file

@ -160,14 +160,14 @@ Here's an example of how you can use the `NotionSearch` component in a Langflow
In this example, the `NotionSearch` component is used to search for pages and databases in Notion based on the provided query and filter criteria. The retrieved data can then be processed further in the subsequent components of the flow. In this example, the `NotionSearch` component is used to search for pages and databases in Notion based on the provided query and filter criteria. The retrieved data can then be processed further in the subsequent components of the flow.
</Admonition> </Admonition>
<Admonition type="tip" title="Best Practices"> ## Best Pratices
When using the `NotionSearch` component, consider the following best practices: When using the `NotionSearch` component, consider the following best practices:
- Ensure that you have a valid Notion integration token with the necessary permissions to search for pages and databases. - Ensure that you have a valid Notion integration token with the necessary permissions to search for pages and databases.
- Provide a meaningful search query to narrow down the results to the desired pages or databases. - Provide a meaningful search query to narrow down the results to the desired pages or databases.
- Choose the appropriate filter type (`page` or `database`) based on your search requirements. - Choose the appropriate filter type (`page` or `database`) based on your search requirements.
- Consider the sorting direction (`ascending` or `descending`) to organize the search results effectively. - Consider the sorting direction (`ascending` or `descending`) to organize the search results effectively.
</Admonition>
<Admonition type="warning" title="Troubleshooting"> <Admonition type="warning" title="Troubleshooting">
If you encounter any issues while using the `NotionSearch` component, consider the following: If you encounter any issues while using the `NotionSearch` component, consider the following: