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.

codebuff public sync bot added 30 commits August 8, 2026 05:57
Source: CodebuffAI/freebuff-private@abcd29465ac194a29430dce33756316dd61f652b
Source: CodebuffAI/freebuff-private@08c88e8453b21b8027cdce0043592828d3c5e180
Source: CodebuffAI/freebuff-private@1cb4f17fb4814cc9afa4231d9111a1f9a563e70d
Source: CodebuffAI/freebuff-private@6fc16ea857499ee845b2852de7f283c54cfa7564
Source: CodebuffAI/freebuff-private@d9e97e4044fe6f9a49530989923ffd1e852eb839
Source: CodebuffAI/freebuff-private@1fed627c22d1841dba0d71d3d6f6faf5d8a2200b
Source: CodebuffAI/freebuff-private@1744e1a92841528fc6f9bad837b4faa18c9cb1ef
Source: CodebuffAI/freebuff-private@98f04ccf42e52a1cabe2f134aba25e0de40d4e85
Source: CodebuffAI/freebuff-private@0f616d6168b7a0b768f8af38461cb3b13adf3121
Source: CodebuffAI/freebuff-private@b71299a424ddf7d197d38091dc3176ddc74fd7cf
Source: CodebuffAI/freebuff-private@945abe127dca797bf661c7d05f820329d91e6bee
Source: CodebuffAI/freebuff-private@35046b4da2cd4489f51768e1ab2e71d9c65472bd
Source: CodebuffAI/freebuff-private@2b304f2e1b8ba7d9224c489a6e845cd83925c8d0
Source: CodebuffAI/freebuff-private@52802887c2f4cb6833f60c0932306a5983b8e401
Source: CodebuffAI/freebuff-private@9b74ca55097e05f28fbf5c24883b6597dce7da8c
Source: CodebuffAI/freebuff-private@19af2f2cd09856f3f282f30ca052940ac42552a9
Source: CodebuffAI/freebuff-private@2a18e7a7d7038b73ad85a826468c2cc55ad931d5
Source: CodebuffAI/freebuff-private@38fba25b942aef8adcba421471841b7b20c7cb30
Source: CodebuffAI/freebuff-private@a0d29b7f4f0a90b16580abad757b26a5582186eb
Source: CodebuffAI/freebuff-private@921f200e8e7da172999f208da09989dd3af2b575
Source: CodebuffAI/freebuff-private@1f8333535dc6d5345c8e25e73da641d7c67258e5
Source: CodebuffAI/freebuff-private@9012406dff8549011f7914f3865020d6d92f68ff
Source: CodebuffAI/freebuff-private@08f68fedbd75e340cc3c727baceb425d3d9a007f
Source: CodebuffAI/freebuff-private@2855edf610713b2d3c74afb774da4618f72a5379
Source: CodebuffAI/freebuff-private@3f5791ef7faa00428a5fe6146f44567b28031aca
Source: CodebuffAI/freebuff-private@c4966e09b849939367e78d93ef402ea655e93848
Source: CodebuffAI/freebuff-private@de27b89ff859dc2518f497bf4e53f58d39f274d1
Source: CodebuffAI/freebuff-private@5641a9afae16a2067cf14dd2796ac0b14103b067
Source: CodebuffAI/freebuff-private@34a62219d1b687dcdc9b4e10e1c8a52eb987a169
Source: CodebuffAI/freebuff-private@74c405bff67f280a90a4786537fcc2a37602b5b2
codebuff public sync bot and others added 22 commits August 14, 2026 00:11
Source: CodebuffAI/freebuff-private@00a7c2553e888f0fbb4479e4f5e26526ba50f363
Source: CodebuffAI/freebuff-private@5d97dbfbf8f9145048b21c597209cd57f59404e5
Source: CodebuffAI/freebuff-private@4a83562392dc7c78ad7d8f998278ef2a859836ed
Source: CodebuffAI/freebuff-private@ebe738616bcf70dc89f73b562cdb57a043d5c9f8
Source: CodebuffAI/freebuff-private@2e01e4960a67436428daf4ec7420610e2e78c3aa
Source: CodebuffAI/freebuff-private@ee03af40b5f2924b3e8f422b6005d0d4be4602e8
Source: CodebuffAI/freebuff-private@92fa84fe0a3526d34845b97b2478530f4fa8f642
Source: CodebuffAI/freebuff-private@4ce94c0de078d08b9c4d39b485ae24ead7197522
Source: CodebuffAI/freebuff-private@19d33ff83bb5bb671ad6cc189e2056b9c482fee3
Source: CodebuffAI/freebuff-private@1a6c72035a19874414203bce978425c79e9cd886
Source: CodebuffAI/freebuff-private@19afaef86a5ecdba5821d46072f4d6c2ff81c98b
Source: CodebuffAI/freebuff-private@690212da677edcc5d0ea1f6905b8fba6efb582fc
Source: CodebuffAI/freebuff-private@1149074355771b4d7783c8f858a7c9a4fdf9a5d4
Source: CodebuffAI/freebuff-private@afa5844e486430adb25a9d7e46c13c7af5ef9a61
Source: CodebuffAI/freebuff-private@25bfb394af0a39596cea05f28d7c677466285c27
Source: CodebuffAI/freebuff-private@8e3c8b91b60640c17406c1fe2f953b9c4a26be1d
Source: CodebuffAI/freebuff-private@db5ee6551f622375780f2809e677867f6c0fcce8
Source: CodebuffAI/freebuff-private@a82f0cbc0e8aa370f0243689d00fb340ca2c18cb
Source: CodebuffAI/freebuff-private@6ed1590f85e7d045b3e8fef3d4c7ac08b7ed2fff
Source: CodebuffAI/freebuff-private@9baf719d8f26b57c23d15633fac65f98ceda0541
Source: CodebuffAI/freebuff-private@368b068cde9415e23c971f62875bcab962c4b9e5
@codebuff-team

ghost commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Thanks for tackling the broken tmux.knowledge.md references in cli/README.md and cli/src/__tests__/README.md — that's a legitimate, low-risk fix and worth porting on its own.

The new docs/development.md, however, needs more care before landing:

  1. Both fixed links now point to docs/testing.md, but this PR doesn't add or reference that file elsewhere as already existing. If docs/testing.md doesn't exist in the tree, you've just swapped one broken link for another — please confirm it exists (or add it) before this is portable.
  2. Several specifics in the new guide — bun start-cli, bun run dev:freebuff, bun run build:freebuff, bun run ci — should be checked against the actual package.json scripts. If any of these don't match real script names, the guide will mislead new contributors, which is worse than no guide.
  3. The workspace table (agent-runtime, code-map, llm-providers, etc.) needs verifying against the current directory layout — some of these paths read like plausible guesses rather than confirmed structure.

Since this is a docs-only PR, the bar is really just factual accuracy — there's no code to review, so every claim needs to be double-checked against the repo you're actually looking at. Please re-verify the links and script names, and mention in the PR description exactly how you validated each one (e.g., "ran bun run dev:freebuff locally and confirmed it starts"). Happy to look again once that's tightened up.

@codebuff-team codebuff-team added bot:triaged Classified by the community triage bot pr:needs-work Right idea, not mergeable as written labels Aug 20, 2026
@kranthik10

ghost commented Aug 20, 2026

Copy link
Copy Markdown
Author

Thanks for the thorough review and feedback! I've gone through and validated every claim against the repository:

1. Verified docs/testing.md

  • Confirmed docs/testing.md is present on main (29KB testing guide).
  • Checked both relative links to ensure they resolve:
    • In cli/README.md: ../docs/testing.md
    • In cli/src/__tests__/README.md: ../../../docs/testing.md

2. Validated All Scripts Locally

I tested and validated each command directly against root package.json:

  • bun run build:sdk: Compiled @codebuff/sdk (ESM/CJS bundles, type definitions, and WASM bindings).
  • bun run build:freebuff: Produced cli/bin/freebuff executable.
  • bun run ci: Successfully ran bun run build:sdk && bun run build:freebuff with exit code 0.
  • bun run dev:freebuff / bun start-cli: Verified entry point execution with configured client environment.
  • Added an explicit Available Root Scripts mapping table in docs/development.md and added a note regarding .env.local requirements for local interactive dev.

3. Verified Monorepo Workspaces

  • Cross-referenced the architecture table against all 10 entries in package.json's "workspaces" field (agents, cli, common, evals, freebuff, packages/agent-runtime, packages/code-map, packages/llm-providers, scripts/tmux, sdk), including adding evals/ (buffbench).

The branch has been updated with these refinements. Ready for another review!

@victorxheng

ghost commented Aug 31, 2026

Copy link
Copy Markdown

Apologies — this PR was auto-closed by GitHub when we force-pushed a history rewrite of this repository (repository maintenance; every commit SHA changed). That was not a judgment on this PR, and GitHub does not allow us to reopen it because the commits it was based on no longer exist in the new history.

If you'd like to continue with this change: rebase your branch onto the new main (or recreate it from a fresh clone) and open a new PR — feel free to link back to this one for context, and we'll pick up the review there.

Sorry for the churn, and thanks for contributing.

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