Skip to content

Conversation

@shvynu
Copy link

@shvynu shvynu commented Aug 27, 2024

Description

This pull request improves the clarity and structure of the documentation for setting up the search engine API keys in Devika. It covers the following:

  • Improved instructions for setting up the Bing Search API.
  • Improved instructions for setting up the Google Search API.
  • Added Markdown formatting for easy readability and structure.
  • Included clear step-by-step procedures with links to relevant external resources.

Explanation:
The changes address the problem of unclear and disorganized instructions in the previous documentation. This updated version provides clear, step-by-step instructions to guide users through the process of setting up API keys for Bing and Google search engines. It also uses Markdown formatting to improve readability.

Test Plan (Required)

To ensure the changes are effective and that the documentation is clear and helpful:

  1. Test 1: Documentation Clarity

    • Command: Review the Markdown file in a Markdown editor/viewer.
    • Expected Outcome: The instructions should be easy to follow, with clear steps and formatting.
    • Actual Outcome: [Describe the outcome after testing]
  2. Test 2: Link Functionality

    • Command: Click all the embedded links in the documentation.
    • Expected Outcome: All links should direct to the correct external resources (e.g., Azure, Google Cloud).
    • Actual Outcome: [Describe the outcome after testing]

- ![Create Search Engine](images/google-2.png)
- After creating the engine, copy the `Search Engine ID`.
- Paste it in the `API_Endpoints` field with the name `GOOGLE_SEARCH_ENGINE_ID` in the `config.toml` file located in the root directory of Devika, or you can set it via the UI.
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this extra backticks

- Click on the `Add` button to create a new search engine.
- ![Create Search Engine](images/google-2.png)
- After creating the engine, copy the `Search Engine ID`.
- Paste it in the `API_Endpoints` field with the name `GOOGLE_SEARCH_ENGINE_ID` in the `config.toml` file located in the root directory of Devika, or you can set it via the UI.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention that you can update via UI. not to change config.toml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants