Skip to content

Conversation

Copy link

Copilot AI commented Jan 13, 2026

Sets up MkDocs with Material theme as the documentation infrastructure for pgvector-python.

Changes

  • Configuration: Added mkdocs.yml with Material theme, syntax highlighting, search, and dark/light mode toggle
  • Dependencies: Added mkdocs>=1.5.0 and mkdocs-material>=9.0.0 to requirements.txt
  • Initial Content:
    • docs/index.md - Project overview and quick start
    • docs/getting-started/installation.md - Setup instructions for all 8 supported database adapters
    • docs/examples/openai.md - Complete OpenAI embeddings example with code samples
    • docs/README.md - Contributor guide
  • Build Tools: Added make docs and make docs-serve targets
  • Housekeeping: Updated .gitignore to exclude site/ build artifacts

Usage

Build documentation:

make docs

Serve locally for development:

make docs-serve

The navigation structure and content organization in mkdocs.yml provides a starting point for expanding documentation page by page.

Original prompt

This section details on the original issue you should resolve

<issue_title>Mkdocs documentation</issue_title>
<issue_description>This library is missing any documentation, everything is in the README.md. Can we add documentation using mkdocs? First setup the framework to add documentation then we will add it page by page</issue_description>

<agent_instructions>Just prepare the code to be able to handle mkdocs then I will take care of adding pages, maybe add one example page</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 13, 2026 13:25
Co-authored-by: jackrua <155536850+jackrua@users.noreply.github.com>
Co-authored-by: jackrua <155536850+jackrua@users.noreply.github.com>
Copilot AI changed the title [WIP] Add mkdocs setup for project documentation Add MkDocs documentation framework Jan 13, 2026
Copilot AI requested a review from jackrua January 13, 2026 13:29
Comment on lines +14 to +19

docs:
mkdocs build

docs-serve:
mkdocs serve
Copy link
Owner

@jackrua jackrua Jan 14, 2026

Choose a reason for hiding this comment

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

I don't want makefile commands I will just use the python venv @copilot

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.

Mkdocs documentation

2 participants