Skip to content

docs:add manual startup guides - #2046

Merged
hidb4ai merged 5 commits into
oceanbase:masterfrom
CX33071:docs/add-manual-start-guide
Oct 17, 2026
Merged

hidb4ai merged 5 commits into
oceanbase:masterfrom
CX33071:docs/add-manual-start-guide

Conversation

@CX33071

@CX33071 CX33071 commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Which issue or RFC does this PR close?

No linked issue. This PR implements a maintainer-requested documentation update.

Rationale for this change

The existing Quick Start guide uses the interactive configuration wizard. Some users need to understand and control the installation and startup
process manually.

This PR adds manual startup guides for users who want to configure and run the PowerContext Server without relying on the setup wizard.

What changes are included in this PR?

  • Add a Chinese manual startup guide.
  • Add an English manual startup guide.
  • Document manual Server configuration, validation, and startup.
  • Document Dashboard access, Scope creation, Codex binding, and Memory verification.
  • Link the manual startup guides from the Chinese and English READMEs.
  • Add both guides to the corresponding documentation navigation.

Are there any user-facing changes?

Yes. This PR adds user-facing documentation only.

It does not change application behavior, APIs, database schemas, or persisted data formats.

How was this change tested?

  • Manually installed and started PowerContext 1.3.0 without the configuration wizard.
  • Validated a manually created environment file with powercontext config validate.
  • Started the Server on http://127.0.0.1:18080.
  • Verified the Server with powercontext doctor, powercontext ready, and powercontext capabilities.
  • Created a Scope manually through the Python Client.
  • Connected Codex and verified the MCP tools.
  • Saved a Memory and successfully recalled it in a new Agent session.
  • Ran git diff --check.

The full make docs-test command was not run because pnpm is not installed in the local environment.

AI usage statement

AI tools were used to help draft and translate the documentation and prepare the PR description. All commands and the documented manual startup
workflow were manually verified locally.

@CLAassistant

CLAassistant commented Oct 17, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@AlexStocks AlexStocks added the 1.4.0 v1.4.0 release tracking label Oct 17, 2026
@CX33071

CX33071 commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor Author

Hi, I added English, Chinese, and Japanese README links, plus English and Chinese manual startup guides. I also verified the full workflow, including Server setup, Scope creation, Codex binding, and cross-session Memory recall. Please review when convenient. Thanks!


## Prerequisites

You need Python 3.11 or newer, Git, [uv](https://docs.astral.sh/uv/getting-started/installation/), and an Agent CLI such as Codex CLI if you want to connect an Agent.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[P1] 本节没有声明平台限制,但后续安装和运行步骤都依赖 POSIX shell 语法(curl | sh、source、env -i、here-document)。Windows 用户即使满足这里列出的 Python/Git/uv/Codex 前置条件,也无法按本页完成手动启动。现有 Quick Start 已明确限定 macOS 或 Linux;请在本页同样声明该限制,或提供完整、可验证的 Windows 等价流程,并同步修正中文页。

@CX33071 CX33071 Oct 17, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out. I added an explicit macOS/Linux platform limitation to both the English and Chinese manual startup guides. The guides now state that they use POSIX shell syntax and do not cover Windows PowerShell.


快速启动使用配置向导:

~~~text

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@CX33071 CX33071 Oct 17, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out. I replaced the Markdown code fences with the standard backtick format in both the Chinese and English manual startup guides for consistency. The changes have been pushed to this PR.

@AlexStocks
AlexStocks requested a balanced review from Copilot October 17, 2026 13:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@hidb4ai

hidb4ai commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

please update & resolve conflicts

@hidb4ai hidb4ai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@hidb4ai
hidb4ai merged commit f2808fb into oceanbase:master Oct 17, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.4.0 v1.4.0 release tracking

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants