fix: 관계의 묶음 이름과 작성자가 쓴 문장을 갈라 놓는다

관계 한 줄에 세 가지가 뭉쳐 있었다. 대상이 어떤 종류인지, 작성자가 왜 걸었는지,
대상이 무엇인지 — 셋 다 `reason` 한 칸을 지나느라 경로마다 다른 것이 같은 자리에
나왔다. 렌더 모델 경로에서는 작성자의 문장이 묶음 이름 자리에 눌려 한 줄짜리 라벨인
척했고, 공개 조회 경로에서는 묶음 이름이 그 자리를 차지하고 작성자의 문장은 아예
버려졌다. 「다음에 무엇을 읽을지」의 답이 그 문장인데 공개 화면에 한 번도 나오지 않았다.

이제 셋이 각자의 칸을 갖는다. `label` 은 대상의 종류, `note` 는 작성자가 쓴 문장,
`summary` 는 대상의 요약이다. 설명 자리에는 문장이 있으면 문장을, 없으면 요약을
보인다 — 요약은 대상을 설명하고 문장은 왜 지금 이것을 읽어야 하는지를 설명한다.

공개 주소로 종류를 되짚던 삼항 사슬도 표로 바꾼다. `/concepts/` 가 어디에도 없어서
개념으로 가는 관계가 전부 `PROJECT` 로 떨어지고 있었다 — 손으로 나열한 목록에 새
종류를 빠뜨리는 일이 이 저장소에서만 다섯 번째다.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011nAjrqNHGPNngN4aUbcyvJ
This commit is contained in:
DongHyeonka
2026-09-01 16:48:11 +09:00
co-authored by Claude Opus 5
parent af5a6bbf23
commit 618a228eff
22 changed files with 698 additions and 76 deletions
@@ -5,6 +5,29 @@ import type { components } from "../../../contracts/studio/generated.ts";
import { ProseText } from "../../shared/public-render/prose-text.tsx";
import { DOCUMENT_KIND_LABELS } from "../../shared/document-kind-labels.ts";
type TargetKind = components["schemas"]["ResolvedRelation"]["targetKind"];
/**
* 공개 주소의 앞머리로 대상 종류를 되짚는다.
*
* <p>목록으로 적는다. 이 자리가 삼항 사슬이던 동안 `/concepts/` 가 어디에도 없어서 개념 문서로
* 가는 관계가 전부 `PROJECT` 로 떨어졌고, 종류 이름이 화면에 「프로젝트」로 나왔다. 종류를
* 더할 때 짝을 빠뜨리는 일이 이 저장소에서만 다섯 번 있었다.
*/
const PATH_PREFIX_KINDS: ReadonlyArray<readonly [string, TargetKind]> = [
["/cases/", "CASE"],
["/references/", "REFERENCE"],
["/questions/", "QUESTION"],
["/concepts/", "CONCEPT"],
];
function targetKindOf(path: string): TargetKind {
const matched = PATH_PREFIX_KINDS.find(([prefix]) => path.startsWith(prefix));
if (matched) return matched[1];
// 결정은 프로젝트 화면 안의 앵커로 산다. 그래서 앞머리가 아니라 조각으로 가른다.
return path.includes("/decisions#") ? "PROJECT_DECISION" : "PROJECT";
}
export function publicRenderModelBase(
record: PublicRecord,
): components["schemas"]["PublicRenderModelBase"] {
@@ -29,21 +52,18 @@ export function publicRenderModelBase(
relations: record.relations.map((relation, index) => ({
id: `public-relation-${index + 1}-${relation.path}`,
targetId: relation.path,
targetKind: relation.path.startsWith("/cases/")
? "CASE"
: relation.path.startsWith("/references/")
? "REFERENCE"
: relation.path.startsWith("/questions/")
? "QUESTION"
: relation.path.includes("/decisions#")
? "PROJECT_DECISION"
: "PROJECT",
targetKind: targetKindOf(relation.path),
title: relation.title,
/*
렌더 모델의 `reason` 은 작성자가 이 관계에 남긴 문장이다. 공개 조회는 그 문장을 `note`
로 주고, `reason` 자리에는 묶음 이름이 온다 — 두 경로에서 같은 이름이 서로 다른 것을
뜻해서, 작성자가 쓴 문장이 화면에 한 번도 나오지 않은 채로 오래 있었다.
*/
publicPath: relation.path,
reason: relation.reason,
reason: relation.note,
/* 계약이 관계마다 주는 요약. 여기서 버리면 목록에 제목만 남는다. */
summary: relation.summary,
order: index + 1,
order: relation.priority || index + 1,
})),
renderContext: {
generatedAt: record.publishedAt,
@@ -1,11 +1,24 @@
import { Link } from "react-router-dom";
/**
* 관계 한 줄.
*
* <p>세 칸이 서로 다른 것을 뜻한다. 오래 이 셋이 `reason` 한 칸에 뭉쳐 있었고, 그래서 화면마다
* 다른 것이 같은 자리에 나왔다 — 렌더 모델 경로에서는 작성자가 쓴 문장이 묶음 이름 자리에 작은
* 회색 글씨로 눌려 나왔고, 공개 조회 경로에서는 작성자가 쓴 문장이 아예 버려졌다.
*/
export type PublicRelation = Readonly<{
/** 왜 걸려 있는지 — 관계 묶음의 사람이 읽는 이름. */
reason: string;
/** 묶음 이름. 「근거」「관련 기준」처럼 분류다. 문장이 아니다. */
label?: string;
title: string;
path: string;
/** 대상 문서의 요약. 눌러 보지 않고도 무엇인지 알게 한다. */
/**
* 작성자가 이 관계에 남긴 문장. 「다음에 무엇을 읽을지」의 답이 이것이다. 있으면 요약보다
* 이쪽을 보인다 — 대상의 요약은 대상을 설명하고, 이 문장은 왜 지금 이것을 읽어야 하는지를
* 설명한다.
*/
note?: string;
/** 대상 문서의 요약. 작성자가 아무것도 남기지 않았을 때의 차선이다. */
summary?: string;
}>;
@@ -25,27 +38,26 @@ export function PublicDocumentRelations({
<p className="section-kicker">{kicker}</p>
<h2 id="relations-title">{title}</h2>
<ul>
{relations.map((relation) => (
<li key={relation.path}>
<Link to={relation.path}>
<span>{relation.reason}</span>
<div>
<strong>{relation.title}</strong>
{/*
계약은 관계마다 요약을 함께 준다. 예전에는 그것을 버려서 목록에 제목만 남았고,
독자는 왜 이 기록이 걸려 있는지 눌러 봐야 알 수 있었다.
*/}
{/*
링크의 이름은 「관계 이름 + 제목」으로 둔다. 요약까지 이름에 들어가면 관계
목록을 훑을 때 링크 하나하나가 문단이 되어 목록으로서 쓸모가 없어진다.
요약은 눈으로 보는 보조 정보이고, 전문은 눌러 들어가면 있다.
*/}
{relation.summary ? <p aria-hidden="true">{relation.summary}</p> : null}
</div>
<span aria-hidden="true">↗</span>
</Link>
</li>
))}
{relations.map((relation) => {
/*
링크의 이름은 「묶음 이름 + 제목」까지다. 설명까지 이름에 들어가면 관계 목록을 훑을 때
링크 하나하나가 문단이 되어 목록으로서 쓸모가 없어진다. 설명은 눈으로 보는 보조
정보이고, 전문은 눌러 들어가면 있다.
*/
const description = relation.note?.trim() || relation.summary?.trim() || "";
return (
<li key={relation.path}>
<Link to={relation.path}>
{relation.label ? <span>{relation.label}</span> : null}
<div>
<strong>{relation.title}</strong>
{description ? <p aria-hidden="true">{description}</p> : null}
</div>
<span aria-hidden="true">↗</span>
</Link>
</li>
);
})}
</ul>
</section>
);
@@ -108,6 +108,11 @@ function ModelDocumentHeader({
);
}
/** 관계 대상의 종류 이름. 프로젝트만 표에 없다 — 기록이 아니라 묶음이기 때문이다. */
function kindLabel(kind: ResolvedRelation["targetKind"]): string {
return kind === "PROJECT" ? "프로젝트" : DOCUMENT_KIND_LABELS[kind];
}
function publicRelations(
relations: ReadonlyArray<ResolvedRelation>,
): PublicRelation[] {
@@ -118,9 +123,12 @@ function publicRelations(
)
.sort((left, right) => left.order - right.order)
.map((relation) => ({
reason: relation.reason,
// 묶음 이름은 대상이 어떤 종류의 기록인가로 붙인다. 「동작 원리」인지 「열린 질문」인지가
// 독자가 목록에서 먼저 가려내는 것이고, 그 이름은 이미 한 곳에 있다.
label: kindLabel(relation.targetKind),
title: relation.title,
path: relation.publicPath,
note: relation.reason,
summary: relation.summary,
}));
}