docs: correct context management workflows - #1566
Merged
Merged
Conversation
There was a problem hiding this comment.
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>
| @@ -0,0 +1,8 @@ | |||
| import { defineConfig } from 'fumadocs-mdx/config'; | |||
There was a problem hiding this comment.
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
marked this pull request as ready for review
September 11, 2026 13:24
Teingi
reviewed
Sep 11, 2026
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.
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
pipefail, temporary files, response validation, and atomic replacement so failed requests cannot overwrite the previous context file.entry_id, andmatched_byfields, plus guidance for first-time embedding enablement.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)POWERCONTEXT_*environment variables)make docs-testwas attempted, but the website build was blocked by pnpm dependency downloads in the current network/non-TTY environment.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.