Add `pg_analytics` docs to the README

[Weijun-H]

What feature are you requesting?

Migrate the documents related to the pg_analytics to its repo

Why are you requesting this feature?

It would be beneficial for the maintenance of 'pg_analytics' to avoid creating multiple pull requests, one for code and another for documentation.

What is your proposed implementation for this feature?

No response

Full Name:

Weijun Huang

Affiliation:

Individual

[philippemnoel]

Perhaps the best approach to this would be to have thorough documentation directly in the README, similar to what pgvector does: https://github.com/pgvector/pgvector

Our idea for separating the two repos is that ParadeDB (the product) is operating the monorepo paradedb/paradedb and subproducts, like pg_analytics, can develop an ecosystem of their own for the community. We only have one Mintlify documentation and it doesn't make sense for pg_analytics to have its own either, so usage of pg_analytics inside ParadeDB should be documented in the monorepo.

But that is a responsibility that can be left to the ParadeDB team. Contributors to pg_analytics can document in pg_analytics README and when the ParadeDB team includes a new version of pg_analytics, we need to update our documentation just like we do for pgvector. What do you think?

The right way to tackle this issue might be to just copy-paste the relevant documentation into the README so the project can fully live on its own.

[Weijun-H]

I see, it is acceptable to follow the pgvector pattern. We could duplicate the related documentation into the README so that the repository could fully showcase its usage.

[philippemnoel]

I'll move this to pg_analytics repo, then