Skip to content

docs: add source installation guide#375

Open
Kaguya-19 wants to merge 12 commits into
OpenBMB:mainfrom
Kaguya-19:fix/deploy_readme_prereqs_0708
Open

docs: add source installation guide#375
Kaguya-19 wants to merge 12 commits into
OpenBMB:mainfrom
Kaguya-19:fix/deploy_readme_prereqs_0708

Conversation

@Kaguya-19

@Kaguya-19 Kaguya-19 commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add a dedicated source installation guide with platform-specific dependency commands
  • keep the main README concise by linking to the detailed guide
  • cover Node.js/node:sqlite, Git/Git LFS, native build tools, ripgrep, clone/install, onboarding, startup, and troubleshooting

Context

Verification

  • documentation-only change
  • checked requirements against install.sh, Dockerfile, and package scripts

@Kaguya-19 Kaguya-19 force-pushed the fix/deploy_readme_prereqs_0708 branch from b943b56 to 2b447d4 Compare July 8, 2026 08:28
@Kaguya-19 Kaguya-19 changed the title docs: list source deployment prerequisites docs: add source installation guide Jul 8, 2026
@Kaguya-19 Kaguya-19 force-pushed the fix/deploy_readme_prereqs_0708 branch from 2b447d4 to 570be6c Compare July 8, 2026 08:36
@Kaguya-19

Copy link
Copy Markdown
Collaborator Author

Updated verification and China network guidance: I tested the source install guide from a clean clone with GIT_LFS_SKIP_SMUDGE=1 through npm install, UI install, builds, bootstrap, and a short production startup readiness check. I also added Chinese docs for npm registry mirror usage and fnm Node.js mirror usage, and verified the npm registry commands with an isolated npm config.

@Kaguya-19 Kaguya-19 force-pushed the fix/deploy_readme_prereqs_0708 branch 2 times, most recently from 9bce903 to ece1fe3 Compare July 8, 2026 09:12
@Kaguya-19

Copy link
Copy Markdown
Collaborator Author

Brand-new install verification: I used an isolated temp HOME, PILOT_HOME, and npm cache. Remote GitHub clone of the PR branch hit in the current network, so I documented that failure mode in the Chinese guide. Using a local clone to simulate a fresh checkout, the documented install path completed: root npm install, UI npm install, bootstrap with empty PILOT_HOME, root/UI builds, and short production startup until both UI and Gateway were ready.

@Kaguya-19

Copy link
Copy Markdown
Collaborator Author

Correction to the previous verification comment: the remote GitHub clone failure was fetch-pack: unexpected disconnect. I added this exact failure mode to the Chinese source install guide, along with retry/proxy guidance and the GIT_LFS_SKIP_SMUDGE=1 workaround for skipping large media assets.

@Kaguya-19 Kaguya-19 force-pushed the fix/deploy_readme_prereqs_0708 branch 2 times, most recently from 90ab067 to 178f931 Compare July 8, 2026 09:25
@Kaguya-19 Kaguya-19 force-pushed the fix/deploy_readme_prereqs_0708 branch from 178f931 to df19df3 Compare July 8, 2026 10:24
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.

1 participant