Skip to content

docs(graph): rework the @ttsc/graph guide, README, and launch post#298

Merged
samchon merged 7 commits into
masterfrom
docs/graph-guide-and-readme
Jul 1, 2026
Merged

docs(graph): rework the @ttsc/graph guide, README, and launch post#298
samchon merged 7 commits into
masterfrom
docs/graph-guide-and-readme

Conversation

@samchon

@samchon samchon commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Intent

Rework the @ttsc/graph documentation set so each surface has one job and stops duplicating the others: the launch post owns the story, the guide owns the reference, the README is a lean landing.

Scope

  • Guide pages (website/src/content/docs/graph/): merged the Tools reference into Design (inline ITtscGraphApplication plus a type-source tab set for the branch and payload types), added a sourced Comparison page (matrix + summary benchmark chart + per-tool source links), and restructured every page into a numbered H2/H3 hierarchy matching the launch post. Embedded the summary benchmark chart on the Overview page. Updated _meta.ts (Overview → Design → Comparison → 3D Viewer).
  • Benchmark (benchmark/graph.mdx): slimmed to the chart, result commentary, and reproduce steps; the tool contract now links to Design and the head-to-head to Comparison.
  • README: rewritten as a lean landing focused on @ttsc/graph itself (install, connect, how it works, benchmark, 3D). The competitor autopsy and narrative move to the launch post and Comparison guide. Banner switched to the graph OG image; broken launch-post and image links fixed.
  • Launch post: replaced em-dashes with colons (house style) in the pain/antidote table and the request-type list.

Notes / deferred

  • Competitor facts (especially serena) are sourced to each tool's own repo and docs as of mid-2026 and flagged as moving targets; they live only in Comparison to avoid double-maintenance.
  • benchmark/graph.mdx intentionally keeps flat headings, matching its sibling benchmark pages.
  • The Design page's inline ITtscGraphApplication shows the IDraft shape landing with the pending source PR; the live LocalSource tabs follow the source.

Test plan

  • prettier run on all changed files (blog and Comparison table normalized; the rest unchanged).
  • Verified: no em-dashes across the graph docs and README, all cross-links resolve (no leftover /docs/graph/tools or /docs/graph/comparison), Design type-source tabs balanced (11 items and 11 panels), the #3-sources anchor matches its heading.
  • Website MDX build validated by CI (not runnable locally).

🤖 Generated with Claude Code

samchon and others added 3 commits July 2, 2026 01:52
Merge the Tools reference into Design (inline ITtscGraphApplication plus a type-source tab set), add a sourced Comparison page carrying the benchmark chart, and restructure every graph guide into a numbered H2/H3 hierarchy. Embed the summary chart on the Overview page, and slim benchmark/graph.mdx to the chart, commentary, and reproduce steps, deferring the contract to Design and the head-to-head to Comparison.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Focus the README on @ttsc/graph itself: install, connect an agent, a compact how-it-works, one benchmark image, and the 3D viewer. Move the competitor autopsy and the narrative to the launch post and Comparison guide, switch the banner to the graph OG image, and fix the launch-post and image links.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The house style forbids em-dashes; replace them in the pain/antidote table and the request-type list.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 1, 2026 16:53
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
samchon and others added 2 commits July 2, 2026 01:55
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

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.

Pull request overview

This PR reorganizes the @ttsc/graph documentation so each surface has a distinct purpose (guide as reference, README as landing, launch post as narrative) while removing duplicated content and adding a sourced comparison page.

Changes:

  • Replaced the old “Tools” guide with a new “Design” reference page, and added a new “Comparison” page (including an embedded summary benchmark chart).
  • Updated the Graph docs overview + viewer pages to match the numbered heading structure and to embed the summary benchmark chart on the overview.
  • Slimmed the benchmark page, refreshed the package README as a lean landing, and applied the colon-style edits in the launch post.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/src/content/docs/graph/viewer.mdx Adds numbered sections/subsections and clarifies viewer usage (run vs dump) and interpretation guidance.
website/src/content/docs/graph/tools.mdx Removes the former Tools reference page (content migrated/restructured into Design).
website/src/content/docs/graph/index.mdx Embeds the summary benchmark chart and updates navigation/structure to point to Design + Comparison.
website/src/content/docs/graph/design.mdx New consolidated reference/design page including request/result contract explanation and live type-source tabs.
website/src/content/docs/graph/compare.mdx New sourced comparison page with a matrix + embedded summary benchmark chart + source links.
website/src/content/docs/graph/_meta.ts Updates the docs sidebar order/entries (Overview → Design → Comparison → 3D Viewer).
website/src/content/docs/benchmark/graph.mdx Slims benchmark documentation to chart + interpretation + reproduce steps, linking out to Design/Comparison/launch post.
website/src/content/blog/i-made-ts-compiler-graph-mcp.mdx Applies the house-style colon formatting in the pain/antidote table and request-type list.
packages/graph/README.md Rewrites README as a lean landing page (install/connect/how it works/benchmark/3D) and updates banner/link targets.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@samchon samchon merged commit d5fa231 into master Jul 1, 2026
28 checks passed
@samchon samchon deleted the docs/graph-guide-and-readme branch July 1, 2026 17:15
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.

2 participants