Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy Documentation

on:
push:
branches: [main]
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'

permissions:
contents: read
pages: write
id-token: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
fetch-depth: 0

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
extended: true

- name: Build
run: cd docs && hugo --minify

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/public

- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,8 @@ go.work
# Files with secrets
.env
tern.conf

# Hugo build output
docs/public/
docs/resources/
docs/.hugo_build.lock
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/themes/book"]
path = docs/themes/book
url = https://github.com/alex-shpak/hugo-book
192 changes: 192 additions & 0 deletions DOCUMENTATION_SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
# Hugo Documentation Structure - Complete

## Summary

Created **50 markdown files** with **17,102 lines** of comprehensive Hugo documentation for dhamps-vdb.

## Directory Structure

```
docs/content/
├── _index.md (main landing page)
├── getting-started/
│ ├── _index.md
│ ├── installation.md
│ ├── docker.md
│ ├── configuration.md
│ ├── quick-start.md
│ └── first-project.md
├── concepts/
│ ├── _index.md
│ ├── architecture.md
│ ├── users-and-auth.md
│ ├── projects.md
│ ├── embeddings.md
│ ├── llm-services.md
│ ├── similarity-search.md
│ └── metadata.md
├── guides/
│ ├── _index.md
│ ├── rag-workflow.md
│ ├── project-sharing.md
│ ├── public-projects.md
│ ├── ownership-transfer.md
│ ├── metadata-validation.md
│ ├── metadata-filtering.md
│ ├── batch-operations.md
│ └── instance-management.md
├── api/
│ ├── _index.md
│ ├── authentication.md
│ ├── query-parameters.md
│ ├── patch-updates.md
│ ├── error-handling.md
│ └── endpoints/
│ ├── _index.md
│ ├── users.md
│ ├── projects.md
│ ├── llm-services.md
│ ├── api-standards.md
│ ├── embeddings.md
│ └── similars.md
├── deployment/
│ ├── _index.md
│ ├── docker.md
│ ├── database.md
│ ├── environment-variables.md
│ └── security.md
├── development/
│ ├── _index.md
│ ├── testing.md
│ ├── contributing.md
│ ├── architecture.md
│ └── performance.md
└── reference/
├── _index.md
├── configuration.md
├── database-schema.md
└── roadmap.md
```

## Content Sources

Documentation was migrated and organized from:
- README.md - Main content, API overview, features
- DOCKER.md - Complete Docker deployment guide
- docs/PUBLIC_ACCESS.md - Public project access (current state)
- docs/METADATA_SCHEMA_EXAMPLES.md - Validation examples
- docs/PERFORMANCE_OPTIMIZATION.md - Performance notes
- docs/LLM_SERVICE_REFACTORING.md - Current state only (no history)
- internal/models/options.go - Configuration options

## Quality Standards Met

✅ **Present tense** - All content describes current state
✅ **User-focused** - Written for end users, not implementers
✅ **Practical examples** - Extensive curl command examples throughout
✅ **Hugo front matter** - All files have proper title and weight
✅ **Information preserved** - No content lost from source files
✅ **No implementation history** - Technical evolution removed
✅ **Metadata filtering** - Correctly documented as EXCLUDE (negative matching)

## Key Features Documented

### Getting Started (6 files)
- Installation from source
- Docker deployment (comprehensive guide)
- Configuration with environment variables
- Quick start curl tutorial
- Complete first project walkthrough

### Concepts (8 files)
- System architecture overview
- Users and authentication
- Project management
- Embeddings storage
- LLM services (definitions vs instances)
- Similarity search algorithms
- Metadata handling

### Guides (9 files)
- RAG workflow implementation
- Project sharing and collaboration
- Public project access
- Project ownership transfer
- Metadata schema validation
- Metadata filtering (exclusion)
- Batch operations
- LLM service instance management

### API Reference (11 files)
- Authentication methods
- Complete endpoint documentation:
- Users management
- Projects CRUD
- LLM services configuration
- API standards definitions
- Embeddings storage
- Similarity search (with metadata filtering)
- Query parameters
- PATCH updates
- Error handling

### Deployment (5 files)
- Docker deployment guide
- PostgreSQL database setup
- Environment variables reference
- Security best practices

### Development (5 files)
- Testing guide
- Contributing guidelines
- Architecture deep-dive
- Performance optimization notes

### Reference (4 files)
- Configuration complete reference
- Database schema documentation
- Product roadmap

## Special Notes

1. **LLM Services Documentation**: Extracted CURRENT STATE from LLM_SERVICE_REFACTORING.md, removed all implementation history and migration notes.

2. **Metadata Filtering**: Correctly documented that `metadata_path` and `metadata_value` perform NEGATIVE MATCHING (exclude documents with matching values).

3. **Public Projects**: Focused on user functionality from PUBLIC_ACCESS.md, removed implementation details.

4. **Docker Guide**: Comprehensive guide created from DOCKER.md with added troubleshooting and verification steps.

5. **Configuration**: Complete documentation of all environment variables from options.go plus ENCRYPTION_KEY.

## Hugo Compatibility

All files include:
- Front matter with `title` field
- Front matter with `weight` field for ordering
- Markdown headers starting at level 1 (#)
- Valid markdown syntax
- Relative links between pages

## Next Steps

1. Configure Hugo site with theme
2. Set up navigation menus
3. Configure search functionality
4. Add site configuration (config.toml/yaml)
5. Deploy to hosting platform
6. Set up CI/CD for automatic deployment

## Verification

All 50 files verified present:
```bash
find docs/content -name "*.md" | wc -l
# Output: 50
```

Total lines of documentation:
```bash
wc -l docs/content/**/*.md | tail -1
# Output: 17102 total
```
Loading