Skip to content

docs: correct context management workflows - #1566

Merged
Teingi merged 11 commits into
masterfrom
codex/review-workflow-docs
Sep 11, 2026
Merged

docs: correct context management workflows#1566
Teingi merged 11 commits into
masterfrom
codex/review-workflow-docs

Conversation

@Zxf-xufeng

Copy link
Copy Markdown
Member

Related issue

None (documentation calibration).

Summary

This PR aligns the context-management workflows with the current implementation and adds verification guidance for the areas most likely to cause incorrect data, permissions, or Scope isolation.

Documentation changes

  • Make the Codex workflow create and bind a dedicated Scope, document the prompt-capture boundary of the hook, and remove the unsupported Workstream selector step.
  • Harden context-text export with pipefail, temporary files, response validation, and atomic replacement so failed requests cannot overwrite the previous context file.
  • Correct the OpenDAL defaults and examples, including the server address, asynchronous Python entry point, bearer-token handling, and file-size limit.
  • Clarify managed Skill package contents, external Skill target scan/resolve behavior, host-local paths, and remote receiver requirements.
  • Add end-to-end vector-search acceptance checks, including the returned mode, entry_id, and matched_by fields, plus guidance for first-time embedding enablement.
  • Document the no-model Experience path and the typed proposal option.
  • Add Prompt CRUD, capability checks, ETag/If-Match handling, and correct Prompt permissions.

User-facing impact

Documentation only. No runtime code or API behavior changes are included. The examples now require checking actual responses, permissions, Scope isolation, and failure handling.

Validation

  • git diff --check
  • .venv/bin/python /tmp/powercontext_workflow_audit.py static (76 fenced Python/JSON blocks checked)
  • Relevant tests: 68 passed, 1 deselected (after removing inherited POWERCONTEXT_* environment variables)
  • make docs-test was attempted, but the website build was blocked by pnpm dependency downloads in the current network/non-TTY environment.
  • Prompt API smoke test confirmed that an unconfigured customization provider returns prompt_customization_unavailable; the prerequisite is now documented.

AI usage

Codex (GPT-5) assisted with the documentation review, implementation cross-checks, example validation, and edits. The final content was reviewed by the submitter.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

license-eye has checked 1509 files.

Valid Invalid Ignored Fixed
1075 1 433 0
Click to see the invalid file list
  • website/source.config.ts
Use this command to fix any missing license headers
```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

Comment thread website/source.config.ts
@@ -0,0 +1,8 @@
import { defineConfig } from 'fumadocs-mdx/config';

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
import { defineConfig } from 'fumadocs-mdx/config';
/*
* Copyright (c) 2026 OceanBase.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { defineConfig } from 'fumadocs-mdx/config';

@Zxf-xufeng
Zxf-xufeng requested review from PsiACE and Teingi September 11, 2026 13:20
@Zxf-xufeng
Zxf-xufeng marked this pull request as ready for review September 11, 2026 13:24
Comment thread docs/zh/docs/workflows/prepare-context-text.md
Comment thread docs/zh/docs/workflows/architecture.md Outdated

@Teingi Teingi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Teingi
Teingi merged commit 04b780c into master Sep 11, 2026
17 checks passed
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