Skip to content

docs: add development guide and fix broken documentation links - #1013

Closed
kranthik10 wants to merge 8420 commits into
CodebuffAI:mainfrom
kranthik10:docs/add-development-guide-and-fix-links
Closed

docs: add development guide and fix broken documentation links#1013
kranthik10 wants to merge 8420 commits into
CodebuffAI:mainfrom
kranthik10:docs/add-development-guide-and-fix-links

Conversation

@kranthik10

Copy link
Copy Markdown

Summary

This PR resolves several broken documentation references across the repository and adds a comprehensive development guide for contributors.

Changes

  • Added docs/development.md: Created the missing development guide referenced in root README.md and README.zh-CN.md. It covers:
    • Monorepo workspace architecture (cli, sdk, common, agents, packages/)
    • Prerequisites (Bun v1.3.14+, Node v22+, tmux)
    • Development setup (bun install, bun start-cli, bun run dev:freebuff)
    • Build commands (bun run build:sdk, bun run build:freebuff)
    • Testing workflows and pre-PR checklist
  • Fixed cli/README.md: Updated broken tmux.knowledge.md link to point to scripts/tmux/README.md and docs/testing.md.
  • Fixed cli/src/__tests__/README.md: Updated broken ../../tmux.knowledge.md reference to point to scripts/tmux/README.md and docs/testing.md.

Verification

  • Verified all relative markdown links resolve to valid files.
  • Built SDK with bun run build:sdk to ensure no build regressions.

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

Labels

bot:triaged Classified by the community triage bot pr:needs-work Right idea, not mergeable as written

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants