Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
52 changes: 52 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Deploy Docusaurus site

on:
push:
branches: [main]
workflow_dispatch:

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

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: website/package-lock.json
- name: Install dependencies
run: npm ci
- name: Build website
run: npm run build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: website/build

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
_site/
*.dic
9 changes: 9 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"chat.tools.terminal.autoApprove": {
"/^cd /Users/danshalev/docs-staging && python3 migrate\\.py$/": {
"approve": true,
"matchCommandLine": true
},
"npm run build": true
}
}
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,6 @@

# https://docs.falkordb.com

## Build


# Build

```bash
bundle install
bundle exec jekyll build
```

# Run

```bash
bundle exec jekyll serve
```
See the `website/` directory for Docusaurus documentation setup.
1 change: 0 additions & 1 deletion References.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "References"
description: Learn more about the Technology behind FalkorDB
nav_order: 998
---

# References
Expand Down
38 changes: 0 additions & 38 deletions _config.yml

This file was deleted.

99 changes: 0 additions & 99 deletions _includes/code_tabs.html

This file was deleted.

36 changes: 0 additions & 36 deletions _includes/components/sidebar.html

This file was deleted.

13 changes: 0 additions & 13 deletions _includes/head_custom.html

This file was deleted.

81 changes: 81 additions & 0 deletions add_h1_headings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
#!/usr/bin/env python3
"""Add H1 headings to all markdown files missing them."""

import os
import re
from pathlib import Path

def has_h1_heading(content_after_frontmatter):
"""Check if content has an H1 heading."""
lines = content_after_frontmatter.strip().split('\n')
for line in lines[:10]: # Check first 10 lines
if line.strip().startswith('# '):
return True
return False

def extract_title_from_frontmatter(content):
"""Extract title from YAML frontmatter."""
match = re.search(r'^---\s*\n(.*?)\n---', content, re.DOTALL | re.MULTILINE)
if match:
frontmatter = match.group(1)
title_match = re.search(r'^title:\s*(.+)$', frontmatter, re.MULTILINE)
if title_match:
title = title_match.group(1).strip()
# Remove quotes if present
title = title.strip('"').strip("'")
return title
return None

def add_h1_heading(filepath):
"""Add H1 heading to a file if it's missing."""
with open(filepath, 'r', encoding='utf-8') as f:
content = f.read()

# Check if file has frontmatter
if not content.startswith('---'):
return False

# Extract title
title = extract_title_from_frontmatter(content)
if not title:
return False

# Split at end of frontmatter
match = re.search(r'^---\s*\n.*?\n---\s*\n', content, re.DOTALL | re.MULTILINE)
if not match:
return False

frontmatter_end = match.end()
frontmatter = content[:frontmatter_end]
after_frontmatter = content[frontmatter_end:]

# Check if H1 already exists
if has_h1_heading(after_frontmatter):
return False

# Add H1 heading
new_content = f"{frontmatter}\n# {title}\n{after_frontmatter}"

with open(filepath, 'w', encoding='utf-8') as f:
f.write(new_content)

return True

def main():
"""Process all markdown files in website/docs."""
docs_dir = Path('/Users/danshalev/docs-staging/website/docs')

fixed_files = []

for md_file in docs_dir.rglob('*.md'):
if add_h1_heading(md_file):
rel_path = md_file.relative_to(docs_dir)
fixed_files.append(str(rel_path))
print(f"✓ Added H1 to: {rel_path}")

print(f"\n{'='*60}")
print(f"Fixed {len(fixed_files)} files")
print(f"{'='*60}")

if __name__ == '__main__':
main()
2 changes: 0 additions & 2 deletions agentic-memory/cognee.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "Cognee"
parent: "Agentic Memory"
nav_order: 2
description: "Build flexible agentic memory with Cognee and FalkorDB"
---

Expand Down
2 changes: 0 additions & 2 deletions agentic-memory/graphiti-mcp-server.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "Graphiti MCP Server"
parent: "Agentic Memory"
nav_order: 3
description: "Run Graphiti MCP server with FalkorDB for AI agent memory in Claude Desktop and other MCP clients"
---

Expand Down
2 changes: 0 additions & 2 deletions agentic-memory/graphiti.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "Graphiti"
parent: "Agentic Memory"
nav_order: 1
description: "Build temporally-aware knowledge graphs with Graphiti and FalkorDB"
---

Expand Down
Loading