refactor: shorten the report - #1
Merged
Merged
Conversation
Pure line-rewrapping from `just format` (typstyle --wrap-text, width 80); no content changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Format the `outline.entry` display only — no `numbering` function is touched — so cross-references (`@fig-...`, `@appendix-...`) stay clean and free of the trailing-dot double-period problem. - Main TOC level 1: uppercase the inner title via `upper(it.inner())` to match the body heading style, leaving the "Chương" supplement as-is. - Figure (image/table/raw) and "Phụ lục" lists: add a period after the number via a scoped `dotted-entry` helper (e.g. "Hình 2.1.", "A. ..."). Document the approach in docs/ai/outline-formatting.md and mark the outline parts of docs/ai/numbering-appendix.md as superseded. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
… pros/cons
=== Summary ===
This commit reduces overall verbosity across the entire report by ~390 lines
(404 insertions, 794 deletions) across 27 files. No content or meaning was
removed — only redundant words, verbose descriptions, and English-prefixed
pros/cons items were tightened.
=== Chapter 1 — index.typ ===
Shortened descriptions across all sections (Lý do chọn đề tài, Mục đích,
Mục tiêu, Đối tượng, Phạm vi, Phương pháp, Chức năng, Công nghệ):
- Removed redundant phrases ("có thể", "một cách", "chúng ta")
- Collapsed verbose footnotes (CRDT, SSE definitions)
- Trimmed function descriptions (8 items) and technology bullets (Web App,
Backend, Grafana, Docker/Traefik/RustFS)
=== Chapter 2 — 19 files ===
The dominant change across 15 evaluation files is removing the English
prefix from pros/cons bullet items:
Before: "High Performance, hiệu suất cao so với các giải pháp khác"
After: "Hiệu suất cao so với các giải pháp khác"
Larger structural trims in 4 files:
- collorative-solution.typ: Removed duplicate Hello example, shortened
OT/CRDT history (removed GROVE acronym, paper title), removed 4 prose
comparison paragraphs (duplicated by table), merged 4 app paragraphs
(Figma/Notion/Linear) into 1
- yjs.typ: Shared Data Types table kept 4/6 types (dropped Y.XmlElement,
Y.XmlText). Editor Bindings kept 2/6 (ProseMirror, Tiptap). Connection
Providers kept 3/8 (y-websocket, y-webrtc, Hocuspocus). Undo/Redo and
Awareness condensed to single paragraphs
- tiptap.typ: Removed architecture table (duplicated by bullet points),
shortened Vai trò với BlockNote to 2 sentences
- prosemirror.typ: Removed entire "Collaborative Editing với ProseMirror"
section (prosemirror-collab not used in project — Yjs handles collab)
=== Chapter 3 — 2 files ===
- health.typ: Shortened probe descriptions, merged sync/async library
features into single sentence, removed verbose intro
- nx-cache.typ: Condensed script mechanics, cache size explanation, and
drawback into tighter prose
=== Chapter 4 — index.typ ===
Consolidated em dashes (—) to double hyphens (--) in table cell text
=== Chapter 5 — index.typ ===
Removed opening emph meta-paragraph. Products: 7 to 6 items (removed
report repo link). Technologies: removed Renovate Bot, merged Docker
and CI/CD. Thuận lợi: removed intro paragraph. Khó khăn: removed 4
niche items (Shadcn paid blocks, watermill-kafka regex, sqlc-gen-go
plugin, file tree component), kept 7 items. Ưu điểm: condensed CI/CD
numbers. Nhược điểm: tightened RAM/Authentik description. Hướng phát
triển: removed intro paragraph.
=== Others ===
- main.typ: Added sticky: true for figure captions to prevent orphan
captions on page breaks
- appendix/sqlc.typ: em dash to double hyphen in heading
KevinNitroG
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR shortens the report from ~130 pages to ~100–105 pages (589 insertions, 955 deletions, 37 files changed), while also fixing outline formatting, figure/table captions, and the cover page.
1. Content reduction (14c3418, 0f6e9ed, 0b0f3ee)
1.1 Chapter 1 — index.typ (+2 / -44)
1.2 Chapter 2 — 19 files, 4 core files deeply trimmed
collorative-solution.typ (+11 / -37):
yjs.typ (+20 / -93):
tiptap.typ (+5 / -29):
prosemirror.typ (+2 / -22):
Remaining 15 evaluation files — uniform change:
+ High Performance, hiệu suất cao so với các giải pháp khác+ Hiệu suất cao so với các giải pháp khác1.3 Chapter 3 — health.typ, nx-cache
health.typ (+5 / -32):
nx-cache.typ (+6 / -28):
usecase.typ (0 / -59) — FILE DELETED:
update-note-seq.mmd,.mmd.hash,.svg1.4 Chapter 4 — index.typ (+1 / -7)
1.5 Chapter 5 — index.typ (+24 / -100)
1.6 Appendix — sqlc.typ
appendix/index.typ)1.7 Reference impact
2. Outline & caption formatting (9833dbb)
2.1 Uppercase chapter titles (TOC level 1)
Chương 1. giới thiệuChương 1. GIỚI THIỆUUses
upper(it.inner())— only uppercases the chapter name, preserves the "Chương" prefix.2.2 Period after caption numbers
Implemented via scoped
dotted-entryhelper inoutline.entrydisplay-only — thenumberingfunction is untouched, so cross-references (@fig-...,@appendix-...) are NOT affected by the trailing dot.2.3 Documentation
docs/ai/outline-formatting.md— 90-line reference documenting the approach for AI agentsdocs/ai/numbering-appendix.md— marked outline section as superseded3. Summary numbering & typographic dash (e5b70dd, 1d009ec)
-to--in summary.typ for consistent typographic dashes4. Prose reflow & cover fixes (af632e5)
typstyle --wrap-textwidth 805. CI/CD (342f52f)
mainbranch — prevents deploy from feature branches6. Per-commit breakdown
af632e5 —
style: reflow prose with typstyle wrap-textPure prose reflow via
typstyle --wrap-text(width 80). No content changes — only line wrapping.Files (6 files, +40 -33):
src/chapter2/yjs.typsrc/chapter2/prosemirror.typsrc/chapter2/tiptap.typsrc/chapter2/hocuspocus.typsrc/chapter2/frontend.typsrc/chapter3/casbin.typImpact: Cosmetic formatting only — 6 files in Chapter 2–3 realigned to consistent 80-char width.
9833dbbf —
fix(outline): uppercase TOC titles and add period after entry numbersOutline display-only formatting —
numberingfunction untouched, so cross-references stay clean. Appliedupper(it.inner())for TOC level 1. Added trailing period for figure/appendix captions via scopeddotted-entryhelper.Files (3 files, +154 -42):
src/main.typdocs/ai/outline-formatting.mddocs/ai/numbering-appendix.mdSpecific changes in
main.typ:"Chương 1. giới thiệu"→"Chương 1. GIỚI THIỆU""Hình 2.1"→"Hình 2.1.""A. Kiến trúc"→"A. Kiến trúc."dotted-entryscoped purely withinoutline.entry— cross-references unaffected14c3418 —
chore: remove sqlc sectionRemoved sqlc appendix — the technology was dropped from the project during POC; the appendix had no remaining value.
Files (2 files, +2 -3):
src/chapter5/index.typsrc/appendix/index.typ#include "sqlc.typ"0f6e9ed —
chore: remove update note seq use caseRemoved redundant "Update note sequence" use case + 3 diagram files (Mermaid source, hash, SVG).
Files (4 files, -95):
src/chapter3/usecase.typsrc/assets/diagrams/update-note-seq.mmdsrc/assets/diagrams/update-note-seq.mmd.hashsrc/assets/diagrams/update-note-seq.svgImpact: -95 lines, 4 files, 1 diagram removed from output.
342f52f —
chore: no deploy beside main branchAdded CI/CD guard — deploy only on
mainbranch.Files (1 file, +1):
.github/workflows/ci.yamlif: github.ref == 'refs/heads/main'on deploy step0b0f3ee —
refactor: trim verbose prose and remove redundant English prefixes in pros/consLargest commit — net -390 lines (+404 -794) across 27 files. Removed verbose phrases, redundant English prefixes, collapsed duplicate sections and paragraphs.
Files (27 files, +404 -794):
src/chapter1/index.typsrc/chapter5/index.typsrc/chapter2/yjs.typsrc/chapter2/collorative-solution.typsrc/chapter3/health.typsrc/chapter3/nx-cache.typsrc/chapter2/tiptap.typsrc/chapter2/prosemirror.typsrc/chapter2/frontend.typsrc/chapter2/authentik.typsrc/chapter2/postgres.typsrc/chapter2/redpanda.typsrc/chapter2/traefik.typsrc/chapter2/go.typsrc/chapter2/nestjs.typsrc/chapter2/casbin.typsrc/chapter2/blocknote.typsrc/chapter2/meilisearch.typsrc/chapter2/grpc.typsrc/chapter2/openapi.typsrc/chapter2/rustfs.typsrc/chapter2/typescript.typsrc/chapter2/database.typsrc/chapter4/index.typsrc/main.typsticky: truefor figure captionssrc/appendix/sqlc.typsrc/chapter2/hocuspocus.typChange patterns:
15 evaluation files: Removed English prefix from pros/cons:
Chapter 1: Cut ~44 lines — removed redundant phrases, CRDT/SSE footnotes, shortened function bullets & technology descriptions
Chapter 2 bulk:
collorative-solution.typ: Merged 4 app paragraphs, removed duplicate Hello examples, dropped GROVE acronymyjs.typ: Subset of data types/editor bindings/providers actually usedtiptap.typ: Removed architecture table (duplicated by bullets)prosemirror.typ: Removed entire prosemirror-collab section (not used)Chapter 3:
health.typ: Shortened probe descriptions, merged sync/async featuresnx-cache.typ: Condensed script mechanics and cache size explanationChapter 4:
--instead of—in table cellsChapter 5: Removed 4/11 niche challenges, merged products 7→6, removed intro paragraphs
main.typ: Addedsticky: truefor figure captions to prevent orphan captions on page breakse5b70dd —
chore: let summary be in outlineAdded "Tóm tắt" to the outline — previously the summary section was outside the numbering system.
Files (1 file, +1 -1):
src/summary.typ#set heading(numbering: "1")to include summary in outline1d009ec —
chore: use -- instead of - in summaryStandardized typographic dash in summary —
--replaces-to match body text convention.Files (1 file, +6 -6):
src/summary.typ7. Full file statistics