Add AI knowledge base and AGENTS.md for documentation mono-repo#18
Open
Add AI knowledge base and AGENTS.md for documentation mono-repo#18
Conversation
- 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
Made-with: Cursor
Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces a structured AI knowledge base for the documentation mono-repo, completing the architecture established in the workflow engine and worker SDK repos.
Changes
AGENTS.mdmkdocs.yml, development commands, conventionsCLAUDE.mdAGENTS.mdand_shared/.github/copilot-instructions.md.agent/knowledge/_shared/(6 files).agent/knowledge/documentation-review-findings.md.agent/rules/(removed)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 dedicatedneops-ai-contextrepository, 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/improveDocumentationbranch to pick up the new docs from the engine and SDK:Alternatively, use the Makefile helper (switches all submodules):
Related PRs
These PRs can be merged independently — the shared knowledge files are self-contained copies.
neops-workflow-engineneops-worker-sdk-py