Improve overal structure & flow

amirhouieh commented 1 month ago

[ ] How is the reading flow and how can we improve it?
[ ] How is the content structured? does it make sense? can we make it better?

Aashish-Upadhyay-101 commented 1 month ago

Overview page:

please open this pdf file I created: Overview page report.pdf

Aashish-Upadhyay-101 commented 1 month ago

Get Started page:

The text could be improved there as well

Aashish-Upadhyay-101 commented 1 month ago

Step 1 - Setup

The text could be improved to something like:

Manage all aspects of your Unbody account effortlessly through the comprehensive dashboard. From account settings and subscription management, projects and more, the dashboard provides you with complete control and flexibility in one seamless platform.

Create a project section:

The image could be a little zoomed out.

learn more link is sending you to a private notion page.

The text there could also be improved to less confusing sentences.

Add source(s) section:

"Learn more about sources here" I think this is supposed to be a link. also text could be improved here as well.

Select a provider:

"providers" link is taking to 404 page

Aashish-Upadhyay-101 commented 1 month ago

Step 2 - Building

Obtain an API key

It could be a lot better to have screenshots navigating to API key generation.

The sub-section inside the Building section is not needed, in my opinion.
- With Google drive
- With Discord, etc These section shouldn't exist there, instead the content of these section could be put inside it's individual Providers section.

The Building section only consist the this page. and this section should redirect to each Providers respectively.

Means click on Google Drive With Google Docs should redirect to this page. and the content should also move to this provider's page.

Aashish-Upadhyay-101 commented 1 month ago

Starter Section:

the Get Started section should also have links to Step 1 - Setup and Step 2 - Building page for new project and api key guide.

for Understanding Semantic Search section I would rather prefer a common generic example for semantic search.

The Code for Understanding semantic search and Generative Search looks little complex and not explained well enough. Feels like there are lots of things going on and lots of things to process for the mind.

Aashish-Upadhyay-101 commented 1 month ago

Tutorial:

The tutorial section better has something like:

How to build a simple TODO app with Unbody? How to build "Something" with Unbody?

It would be better to have a video form tutorial too.

Aashish-Upadhyay-101 commented 1 month ago

API --> Authorization

is that CURL request working for you?

API --> Search ---> Semantic Search

It would be better to have a good concise difference between Lexical vs Semantic searching in the first paragraph.

for this query: unbody.get.<object_name>.search.about("query", {...options}) would be better to have a link pointing to what are available and what are ...options

Aashish-Upadhyay-101 commented 1 month ago

Docs search not working !

Aashish-Upadhyay-101 commented 1 month ago

API --> Search ---> Hybrid Search

I don't really get what exactly is Hybrid Search and what is it's exact use case, could be better to have a real example.

similarly examples should have exec function

The docs say about relativeScoreFusion argument for hybrid search but not sure what it is, and the SDK also doesn't have that property.

Aashish-Upadhyay-101 commented 1 month ago

API --> Search --> Record Similarity

type Unbxd in the first paragraph's last line.

amirhouieh commented 1 month ago

Tutorial:

The tutorial section better has something like:

How to build a simple TODO app with Unbody? How to build "Something" with Unbody?

It would be better to have a video form tutorial too.

This needs to be discussed further! while I agree with the idea of TODO but that is difficult to come up with such a example without making it too complex! how about we go around functionalities or features. for example "how to build a semantic search" ? if not then we need to come up with super simple ideas; for example "build a move recommended system" ? and then it can evolve over multiple steps.

amirhouieh commented 1 month ago

Docs search not working !

@jeangovil

amirhouieh commented 1 month ago

API --> Search ---> Hybrid Search

I don't really get what exactly is Hybrid Search and what is it's exact use case, could be better to have a real example.

similarly examples should have exec function

The docs say about relativeScoreFusion argument for hybrid search but not sure what it is, and the SDK also doesn't have that property.

We have 3 search methods; semantic wich is base on concept and meaning, bm25 which is key word matching and then hybrid which combines these two methods.

unbody-io / unbody.io