Skip to content

split docs into chapters#312

Open
yangm2 wants to merge 3 commits intocodeforpdx:mainfrom
yangm2:move-split-docs
Open

split docs into chapters#312
yangm2 wants to merge 3 commits intocodeforpdx:mainfrom
yangm2:move-split-docs

Conversation

@yangm2
Copy link
Copy Markdown
Contributor

@yangm2 yangm2 commented Apr 3, 2026

reorganize Evaluation for targeted audiences

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update
  • Infrastructure
  • Maintenance

Description

Reorganize the long Architecture, Deployment and Evaluation docs so that relevant information is easier to find and digest. The files are now in ...

\- docs
   |- Architecture
   |- Deployment
   \- Evaluation

Related Tickets & Documents

  • Related Issue #
  • Closes #

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note on the devices and browsers this has been tested on, as well as any relevant images for UI changes.

Added/updated tests?

  • Yes
  • No, and this is why: only doc changes, no code
  • I need help with writing tests

Documentation

  • If this PR changes the system architecture, Architecture.md has been updated

[optional] Are there any post deployment tasks we need to perform?

yangm2 added 3 commits April 6, 2026 20:00
reorganize Evaluation for targeted audiences
expand LangSmith deployment instructions
@yangm2 yangm2 force-pushed the move-split-docs branch from 86ca1da to 665a148 Compare April 7, 2026 03:00
@yangm2 yangm2 self-assigned this Apr 7, 2026
@yangm2 yangm2 requested review from apkostka and leekahung April 7, 2026 03:03
@yangm2 yangm2 added the documentation Improvements or additions to documentation label Apr 7, 2026
@yangm2 yangm2 requested a review from lee-coates April 7, 2026 03:03
@yangm2 yangm2 marked this pull request as ready for review April 7, 2026 03:03
@leekahung
Copy link
Copy Markdown
Contributor

@claude pr-review

@claude

This comment was marked as outdated.

@leekahung
Copy link
Copy Markdown
Contributor

@claude pr-review

@github-actions
Copy link
Copy Markdown
Contributor

No code snapshot is available for this PR. The snapshot job may not have run or may have failed — check the PR checks workflow and re-trigger by commenting @claude once it completes.

@leekahung
Copy link
Copy Markdown
Contributor

leekahung commented Apr 27, 2026

Couldn't get claude running the review here on GitHub, had Claude Code run the review from my end. Here's the audit outside of the merge conflict.

Code Review

Blockers

  • config/README.md not updated — Lines 3 and 14 reference ../Deployment.md and ../Deployment.md#manual-server-configuration-changes. Since Deployment.md is deleted by this PR, those become broken links. The anchor #manual-server-configuration-changes will need to map to the appropriate section in docs/Deployment/.

Warnings

  • Stale link text in new doc files — Several places in the new docs/ files use old paths as the visible text but correct new URLs, e.g.:

    • [`backend/evaluate/EVALUATION.md`](../Evaluation/README.md) appears in two places
    • [Architecture.md](../Architecture/README.md) appears in multiple footers
    • [EVALUATION.md](../Evaluation/README.md) appears in a few places

    The links resolve correctly, but the display text describes files that no longer exist. Should use the new names as text (e.g., [docs/Evaluation/](../Evaluation/README.md)).

  • Directory tree in docs/Architecture/02-backend-overview.md still shows │ └── EVALUATION.md # Evaluation docs reflecting the old backend/evaluate/EVALUATION.md location. Should be updated to note the file moved to docs/Evaluation/.

Suggestions

  • The PR body describes the new structure but doesn't mention that the three original monolithic files are deleted. Noting that in the description would help reviewers understand the full scope at a glance.
  • The old .claude/CLAUDE.md had a pre-existing bug (See docs/EVALUATION.md for details. — that file never existed at that path). The PR corrects it to docs/Evaluation/ — worth calling out in the PR description as a drive-by fix.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants