Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: add rag and vocational task guides#686

Open
jackefn wants to merge 1 commit into
THU-MAIC:main from
BUPT-CAD-Lab:docs/rag-vocational-existing-docs
Open

docs: add rag and vocational task guides #686
jackefn wants to merge 1 commit into
THU-MAIC:main from
BUPT-CAD-Lab:docs/rag-vocational-existing-docs

Conversation

@jackefn

@jackefn jackefn commented Jun 8, 2026
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Port the existing RAG / Local Knowledge and vocational task-engine documentation from the current project into the upstream OpenMAIC docs site.

This is a docs-only PR. It adds the original multi-language guide pages for local knowledge RAG and vocational task generation, and links them from the docs navigation.

Related Issues

N/A

Changes

  • Add existing Local Knowledge RAG guide pages:
    • local-knowledge-rag.mdx
    • local-knowledge-rag.zh-cn.mdx
    • local-knowledge-rag.zh-tw.mdx
    • local-knowledge-rag.ja.mdx
    • local-knowledge-rag.ru.mdx
    • local-knowledge-rag.ar.mdx
  • Add existing vocational task-engine guide pages:
    • vocational-task-engine.mdx
    • vocational-task-engine.zh-cn.mdx
    • vocational-task-engine.zh-tw.mdx
    • vocational-task-engine.ja.mdx
    • vocational-task-engine.ru.mdx
    • vocational-task-engine.ar.mdx
  • Update packages/docs/content/docs/meta.json so the new guide pages appear in the docs navigation.
  • Update configuration docs across supported docs locales with the original knowledge-base / embedding environment-variable references.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • CI/CD or build changes

Verification

Steps to reproduce / test

  1. Run formatting check:
    pnpm check
  2. Run lint:
    pnpm lint
  3. Run TypeScript check:
    npx tsc --noEmit
  4. Open the docs navigation and verify the Local Knowledge RAG and Vocational Task Engine pages are listed.

What you personally verified

  • pnpm check passed.
  • pnpm lint passed with existing warnings only and no errors.
  • npx tsc --noEmit passed.
  • Verified the branch contains docs-only changes: docs navigation, configuration docs, and the existing RAG / vocational guide pages.
  • Did not run a full docs production build or attach screenshots.

Evidence

  • CI passes (pnpm check && pnpm lint && npx tsc --noEmit)
  • Manually tested locally
  • Screenshots / recordings attached (if UI changes)

Local verification logs:

pnpm check
All matched files use Prettier code style!
pnpm lint
0 errors, existing warnings only
npx tsc --noEmit
passed

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have added/updated documentation as needed
  • My changes do not introduce new warnings

wyuc commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Thanks for the docs. Flagging the disposition here so this is not left wondering: I'd like to park this one for now rather than review the wording yet.

The two new guides document the RAG (#684) and vocational task-engine (#685) features, and both of those are going through a meaningful re-scope right now (the RAG one in particular, to align with the MAIC ETL plan in #621: provider-shaped embedding/index, extractor layer first, and the knowledge-base surface behind a default-off flag). So the guides currently describe a moving target, and the setup and UI flows they document will change. Iterating on the prose now would mostly be redone.

Suggested path:

One unrelated note: the configuration.mdx edit here removes the MiniMax web-search section, which is independent of RAG and vocational. If that cleanup is correct, it could go in on its own small PR without waiting on the feature work. Happy to take it separately.

No action needed from you right now. We'll pick the docs back up once the feature PRs land.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

AltStyle によって変換されたページ (->オリジナル) /