Skip to content

Commit 65db6f9

Browse files
authored
Merge pull request #1527 from swirlai/doc_updates_40
additional 4.0 doc updates; including some color and font corrections…
2 parents 4939e8c + a341c9b commit 65db6f9

File tree

6 files changed

+18
-9
lines changed

6 files changed

+18
-9
lines changed

docs/AI-Connect.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -341,9 +341,12 @@ This will ensure you see messages from the `celery-beats` log. However, most of
341341

342342
# Managing Prompts
343343

344-
## Default Prompt
344+
## Default Prompts
345345

346-
You can view the default prompts from the SWIRL AI Connect page:
346+
{: .warning }
347+
If you edit a default system prompt, your changes will be lost the next time you update SWIRL.
348+
349+
You can view the default prompts from the SWIRL AI Connect page: [localhost:8000/swirl/prompts/](http://localhost:8000/swirl/prompts/)
347350

348351
## Creating New Saved Prompts
349352

@@ -358,7 +361,7 @@ For example, to modify the default prompt so that the response is in pirate-spea
358361
"name": "pirate",
359362
... etc ...
360363
"footer": "--- Final Instructions ---\nIn your response, pretend you are a pirate comedian, but keep it clean!",
361-
"tags": []
364+
"tags": [ "search-rag" ]
362365
}
363366
```
364367

docs/M365-Guide.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,17 @@ python swirl.py restart
200200
The SWIRL distribution includes pre-configured SearchProviders for Outlook Email, Calendar Events, OneDrive Files, SharePoint Sites, and Teams Chat.
201201

202202
{: .warning }
203-
The local Teams app must already be open when clicking a Teams Chat result link in order for Teams to take you to the correct chat.
203+
The local Teams app must already be open when clicking a Teams Chat result link in order for Teams to take you to the correct chat.
204204

205205
{: .highlight }
206-
For results containing recurring Microsoft 365 Calendar events or nested Outlook Message threads, only the most recent events and messages are shown.
206+
> For results containing recurring Microsoft 365 Calendar events or nested Outlook Message threads, only the most recent events and messages are shown.
207+
>
208+
> OneDrive results return only documents, folders are omitted from results.
209+
>
210+
> Teams results ONLY return chat matches; documents shared in chats are found in OneDrive or SharePoint results.
207211
208212
{: .highlight }
209-
In version 3.0.0, the OneDrive SearchProvider was updated to omit folders as results; it now only returns documents.
213+
To search all Microsoft sources at once, use the `microsoft:` prefix.
210214

211215
* Open the admin console: <http://localhost:8000/swirl/>
212216

docs/SP-Guide.md

+3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ nav_order: 15
1717
{: .warning }
1818
This version applies to the Community Edition of SWIRL!
1919

20+
{: .highlight }
21+
SWIRL queries are subject to any rate limits or throttling imposed by the sources being queried.
22+
2023
SearchProviders are the essential element of SWIRL. They make it quick and easy to connect SWIRL to sources without writing any code.
2124

2225
SearchProviders are JSON objects. SWIRL's distribution comes preloaded with a variety of configurations for sources like Elastic, Solr, PostgreSQL, BigQuery, NLResearch.com, Miro.com, Atlassian, and more.

docs/_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ callouts_level: loud # or quiet
4444
callouts:
4545
highlight:
4646
title: Note
47-
color: yellow
47+
color: blue
4848
warning:
4949
title: Warning
5050
color: red

docs/_includes/footer_custom.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ <h4 id="support">Support</h4>
33
<li>Chat: <a href="https://join.slack.com/t/swirlmetasearch/shared_invite/zt-2sfwvhwwg-mMn9tcKhAbqXbrV~9~Y1eA">SWIRL Slack</a></li>
44
<li>Email: <a href="mailto:support@swirlaiconnect.com">support@swirlaiconnect.com</a></li>
55
</ul>
6-
<p class="text-small text-grey-dk-100 mb-0">Copyright &copy; 2024 Swirl, Inc.</p>
6+
<p class="text-small text-grey-dk-100 mb-0">Copyright &copy; 2025 Swirl, Inc.</p>

docs/_sass/custom/custom.scss

-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ a.site-title.lh-tight {
1111
}
1212
#markdown-toc li a {
1313
color: goldenrod;
14-
font-weight: lighter;
1514
}
1615

1716
// Make the separators into non-clickable section headers

0 commit comments

Comments
 (0)