Skip to content

Add AI knowledge base and AGENTS.md for documentation mono-repo#18

Open
griase94 wants to merge 6 commits intomainfrom
feature/improveDocumentation
Open

Add AI knowledge base and AGENTS.md for documentation mono-repo#18
griase94 wants to merge 6 commits intomainfrom
feature/improveDocumentation

Conversation

@griase94
Copy link
Contributor

@griase94 griase94 commented Mar 3, 2026

Summary

Introduces a structured AI knowledge base for the documentation mono-repo, completing the architecture established in the workflow engine and worker SDK repos.

Note: The changes in .make_scripts need to be done in the docs-assets repo as well and then synced to all other repos (for completeness).

Changes

File Purpose
AGENTS.md Vendor-neutral AI context — MkDocs architecture, submodule layout, auto-generated mkdocs.yml, development commands, conventions
CLAUDE.md Claude Code entry point, pointers to AGENTS.md and _shared/
.github/copilot-instructions.md GitHub Copilot project context
.agent/knowledge/_shared/ (6 files) Consolidated ecosystem overview, component architectures, documentation playbook, personas, cross-project patterns, bootstrapping guide
.agent/knowledge/documentation-review-findings.md Project-specific persona review results
.agent/rules/ (removed) Content merged into shared knowledge files

Architecture

The _shared/ directory is identical across all three repos (neops, neops-workflow-engine, neops-worker-sdk-py). It is designed for future extraction into a dedicated neops-ai-context repository, which would be added as a git submodule at .agent/shared/ in each component repo — eliminating the current manual sync.

How to View the Full Docs

The documentation submodules need to be switched to the feature/improveDocumentation branch to pick up the new docs from the engine and SDK:

# Initialize submodules (if not already done)
git submodule update --init --recursive

# Switch engine and SDK submodules to the documentation branch
cd docs/neops-workflow-engine && git fetch && git checkout feature/improveDocumentation && cd ../..
cd docs/neops-worker-sdk-py && git fetch && git checkout feature/improveDocumentation && cd ../..

# Serve the full docs
make doc-serve    # http://localhost:8000

Alternatively, use the Makefile helper (switches all submodules):

make update-submodules BRANCH=feature/improveDocumentation
make doc-serve

Note: After these PRs are merged to develop, a regular git submodule update --init --recursive will suffice.

Related PRs

These PRs can be merged independently — the shared knowledge files are self-contained copies.

Repo PR Description
neops-workflow-engine zebbra/neops-workflow-engine#173 Engine docs: full overhaul, Docker Compose, AI knowledge base
neops-worker-sdk-py zebbra/neops-worker-sdk-py#128 SDK docs: overhaul, cross-project alignment, AI knowledge base

griase94 added 6 commits March 3, 2026 16:59
- Add AGENTS.md as primary AI context file for the docs mono-repo
- Add CLAUDE.md and .github/copilot-instructions.md for tool parity
- Create .agent/knowledge/_shared/ with 6 shared knowledge files
  (identical to component repos for future neops-ai-context extraction)
- Keep project-specific documentation-review-findings.md
- Remove .agent/rules/ (content merged into shared knowledge files)

Made-with: Cursor
The pymdownx.snippets extension could not resolve repo-relative snippet
paths (e.g. "examples/hello.yaml") from submodule documentation when
built in the mono-repo context. The fix detects submodule directories
(those containing mkdocs_custom.yml) and adds both their root and docs
directories to the snippets base_path configuration.

Made-with: Cursor
Required to render tab-based content from submodule docs (e.g. engine
setup page) when building the full platform documentation.

Made-with: Cursor
Same extra.css as the engine repo: bordered container and colored label
bar so tabbed sections are clearly identifiable.

Made-with: Cursor
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.

1 participant