Skip to content

feat: add versioned docs to website - #3

Merged
jaymyaka merged 4 commits into
mainfrom
feature/unified-docs
Jun 12, 2026
Merged

jaymyaka merged 4 commits into
mainfrom
feature/unified-docs

Conversation

@jaymyaka

Copy link
Copy Markdown
Member

Consolidate documentation from dataenginex and dex-studio repos into the existing Pelican marketing site.

  • Pelican config: update Docs nav URL to local, remove sitemap plugin
  • New deps: jinja2, markdown, pyyaml, poe build-docs/build-pelican tasks
  • Templates: docs/base.html and docs/doc.html with sidebar, version selector, breadcrumbs, TOC, SEO meta, JSON-LD
  • CSS: docs layout, search UI, responsive sidebar
  • JS: client-side search overlay with highlight
  • Build script: walks docs-store/, renders .md->.html, generates sitemap.xml, robots.txt, search-index.json, minifies output
  • Sync workflow: repository_dispatch + workflow_dispatch to pull docs from source repo releases
  • CLAUDE.md updated with docs build architecture

Summary

Related Issues

Changes

  • New feature
  • Bug fix
  • Refactor
  • Documentation
  • CI/CD

Checklist

  • Tests added/updated
  • Documentation updated (if applicable)
  • uv run poe lint passes
  • uv run poe typecheck passes
  • uv run poe test passes
  • No breaking changes (or documented in description)

Consolidate documentation from dataenginex and dex-studio repos into
the existing Pelican marketing site.

- Pelican config: update Docs nav URL to local, remove sitemap plugin
- New deps: jinja2, markdown, pyyaml, poe build-docs/build-pelican tasks
- Templates: docs/base.html and docs/doc.html with sidebar, version
  selector, breadcrumbs, TOC, SEO meta, JSON-LD
- CSS: docs layout, search UI, responsive sidebar
- JS: client-side search overlay with highlight
- Build script: walks docs-store/, renders .md->.html, generates
  sitemap.xml, robots.txt, search-index.json, minifies output
- Sync workflow: repository_dispatch + workflow_dispatch to pull
  docs from source repo releases
- CLAUDE.md updated with docs build architecture
Comment thread .github/workflows/sync.yml Fixed
…ntain permissions'

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Preview deployed

URL: https://86d0eef8.thedataenginex-org.pages.dev

This preview will be updated on each push to this PR.

@jaymyaka
jaymyaka merged commit ef03dc6 into main Jun 12, 2026
6 checks passed
@jaymyaka
jaymyaka deleted the feature/unified-docs branch June 12, 2026 03:22

This branch was successfully deployed

2 active deployments
thedataenginex-org (Preview) — 0ccb8c4c Deployed Jun 12, 2026 by github-actions[bot]
preview — 0ccb8c4c Deployed Jun 12, 2026 by jaymyaka via Deploy PR preview #19
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.

2 participants