structured-gist 0.9.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- structured_gist-0.9.0/.gitignore +4 -0
- structured_gist-0.9.0/CHANGELOG.md +23 -0
- structured_gist-0.9.0/LICENSE +202 -0
- structured_gist-0.9.0/NOTICE +11 -0
- structured_gist-0.9.0/PKG-INFO +361 -0
- structured_gist-0.9.0/README.md +341 -0
- structured_gist-0.9.0/pyproject.toml +52 -0
- structured_gist-0.9.0/skills/structured-gist/render/claim_list.py +371 -0
- structured_gist-0.9.0/skills/structured-gist/render/claim_list.schema.json +50 -0
- structured_gist-0.9.0/skills/structured-gist/tests/lint_outline.py +1020 -0
- structured_gist-0.9.0/src/structured_gist/__init__.py +12 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Release notes for tagged versions. The release workflow publishes the section that matches the tag. The full per-version history, including releases before 0.9.0, is in [skills/structured-gist/CHANGELOG.md](skills/structured-gist/CHANGELOG.md).
|
|
4
|
+
|
|
5
|
+
## [Unreleased]
|
|
6
|
+
|
|
7
|
+
## [0.9.0] — 2026-10-19
|
|
8
|
+
|
|
9
|
+
First release on PyPI. It covers the unreleased 0.7.0 and 0.8.0 work and the changes below.
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- Python package `structured-gist` on PyPI. It installs the stdlib-only outline linter as the `structured-gist-lint` command and the `structured_gist` import package.
|
|
14
|
+
- Linter rule R17, advisory only: `structured-gist-lint --advisory` flags a `↪` explanation leaf that holds 2 or more commas outside code, quotes and parentheses. Advisories never change the exit code. R17 stays advisory until hedge detection exists ([#9](https://github.com/domattioli/structured-gist/issues/9)).
|
|
15
|
+
- `SKILL.md` pre-emit check: a six-step pass over word caps, enumerator case, delimiter tails, arrow rarity, sibling families and line width, run before an outline is sent ([#22](https://github.com/domattioli/structured-gist/issues/22)).
|
|
16
|
+
- Smoke-test ratchet on the benchmark renderings: `tests/renderings_lint_baseline.json` holds per-rule violation counts, and smoke fails when any rule's count rises ([#22](https://github.com/domattioli/structured-gist/issues/22)).
|
|
17
|
+
- Tag-push release workflow: tests, version gate, PyPI publish and GitHub release. Zenodo archives each GitHub release under the concept DOI.
|
|
18
|
+
|
|
19
|
+
### Changed
|
|
20
|
+
|
|
21
|
+
- Benchmark metric is `fact_retention_delta`, replacing `word_count_reduction_pct` (0.7.0). Output length is no longer the headline number ([#28](https://github.com/domattioli/structured-gist/issues/28)).
|
|
22
|
+
- The `block` line budget follows the terminal: `width auto` resolves to the terminal width minus 8, clamped to 32-120, and 64 when no width is known (0.8.0).
|
|
23
|
+
- Citation metadata names Dominik O. Mattioli with ORCID 0000-0002-7327-6337.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the
|
|
44
|
+
purposes of this License, Derivative Works shall not include works
|
|
45
|
+
that remain separable from, or merely link (or bind by name) to the
|
|
46
|
+
interfaces of, the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including the
|
|
49
|
+
original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright
|
|
52
|
+
owner or by an individual or Legal Entity authorized to submit on
|
|
53
|
+
behalf of the copyright owner. For the purposes of this definition,
|
|
54
|
+
"submitted" means any form of electronic, verbal, or written
|
|
55
|
+
communication sent to the Licensor or its representatives, including
|
|
56
|
+
but not limited to communication on electronic mailing lists, source
|
|
57
|
+
code control systems, and issue tracking systems that are managed by,
|
|
58
|
+
or on behalf of, the Licensor for the purpose of discussing and
|
|
59
|
+
improving the Work, but excluding communication that is conspicuously
|
|
60
|
+
marked or otherwise designated in writing by the copyright owner as
|
|
61
|
+
"Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing
|
|
142
|
+
the origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright (c) 2024-2026 the authors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
structured-gist
|
|
2
|
+
Copyright 2026 Dominik Mattioli and structured-gist contributors
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0
|
|
5
|
+
(see LICENSE). Redistributions of this work, or of derivative works,
|
|
6
|
+
must retain this NOTICE file.
|
|
7
|
+
|
|
8
|
+
Please cite this work when you use it:
|
|
9
|
+
Mattioli, D. structured-gist. Zenodo. https://doi.org/10.5281/zenodo.22670068
|
|
10
|
+
Source: https://github.com/domattioli/structured-gist
|
|
11
|
+
Machine-readable citation: CITATION.cff
|
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: structured-gist
|
|
3
|
+
Version: 0.9.0
|
|
4
|
+
Summary: Deterministic linter for structured-gist nested lecture-note outlines
|
|
5
|
+
Project-URL: Homepage, https://github.com/domattioli/structured-gist
|
|
6
|
+
Project-URL: Repository, https://github.com/domattioli/structured-gist
|
|
7
|
+
Project-URL: Issues, https://github.com/domattioli/structured-gist/issues
|
|
8
|
+
Project-URL: DOI, https://doi.org/10.5281/zenodo.22670068
|
|
9
|
+
Author: Dominik O. Mattioli
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: NOTICE
|
|
13
|
+
Keywords: agent-skill,claude-code,linter,outline,structured-notes
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: Text Processing :: Markup
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
21
|
+
# structured-gist
|
|
22
|
+
|
|
23
|
+
<p align="center"><img src="https://raw.githubusercontent.com/domattioli/structured-gist/main/docs/assets/hero.svg" alt="structured-gist: Input, agentic-AI word vomit; Output, a skimmable outline" width="100%"></p>
|
|
24
|
+
|
|
25
|
+
[](https://github.com/domattioli/structured-gist/releases)
|
|
26
|
+

|
|
27
|
+
[](https://github.com/domattioli/structured-gist/actions/workflows/tests.yml)
|
|
28
|
+
[](https://doi.org/10.5281/zenodo.22670068)
|
|
29
|
+
[](https://github.com/karanb192/awesome-claude-skills)
|
|
30
|
+
|
|
31
|
+
A skill turning agentic-AI word vomit into a skimmable gist. Information is encoded intuitively within a nested bulleted structure and via node depth; prose stays confined to explanation nodes.
|
|
32
|
+
|
|
33
|
+
## Contents
|
|
34
|
+
|
|
35
|
+
1. [Motivation](#1-motivation)
|
|
36
|
+
2. [Installation](#2-installation)
|
|
37
|
+
3. [Usage](#3-usage)
|
|
38
|
+
4. [Method](#4-method)
|
|
39
|
+
5. [Benchmarks](#5-benchmarks)
|
|
40
|
+
6. [Limitations](#6-limitations)
|
|
41
|
+
7. [Future work](#7-future-work)
|
|
42
|
+
8. [Documentation](#8-documentation)
|
|
43
|
+
9. [Contributing](#9-contributing)
|
|
44
|
+
10. [Reuse and training](#10-reuse-and-training)
|
|
45
|
+
11. [License](#11-license)
|
|
46
|
+
|
|
47
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
48
|
+
|
|
49
|
+
## 1. Motivation
|
|
50
|
+
|
|
51
|
+
Claude's explanatory prose is increasingly a dense, rambling, incomprehensible mess with unexplained jargon and padded with filler. Word-count compression does not fix this. For instance, [caveman](https://github.com/JuliusBrussee/caveman), can shorten Claudish prose but does not reorganize it. Other mechanisms like [claudish-to-english](https://github.com/gvzdv/claudish-to-english) still rely on unstructured prose. Both are useful, but neither deterministically cuts through the noise.
|
|
52
|
+
|
|
53
|
+
What's missing is structure: concept, sub-concept, and the relationship between them. This is also how a well-built lecture teaches a complex subject, and how a good slide deck gets built: one concept per slide, minimal words, relationships carried by layout instead of prose.
|
|
54
|
+
|
|
55
|
+
`structured-gist` renders that decomposition as an explicit tree instead of a paragraph the reader has to parse for it. We can't get rid of the AI slop, but we can push it to the peripheries and help you get to the gist faster.
|
|
56
|
+
|
|
57
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
58
|
+
|
|
59
|
+
## 2. Installation
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
/plugin marketplace add domattioli/structured-gist
|
|
63
|
+
/plugin install structured-gist
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
The outline linter and claim-list renderer also ship on PyPI, stdlib only:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
pip install structured-gist
|
|
70
|
+
structured-gist-lint your_output.md # exit 1 on any violation
|
|
71
|
+
structured-gist-lint --advisory your_output.md # also print R17 advisories
|
|
72
|
+
structured-gist-claims your_output.md # JSONL claim list
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
In Python, `from structured_gist.lint_outline import lint_text`.
|
|
76
|
+
|
|
77
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
78
|
+
|
|
79
|
+
## 3. Usage
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
/structured-gist [block [width N|auto]|responsive]
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Output uses one granularity level, `standard`. The `skim` and `deep` levels are archived (see [Future work](#7-future-work)). No mode given defaults to `block` on all surfaces; pick `responsive` explicitly for a real GFM nested list on a markdown-rendering surface. The `block` line budget is 64 columns by default. `width auto` sizes it to the terminal (terminal width minus 8, clamped to 32-120), and `width N` sets it exactly with no cap.
|
|
86
|
+
|
|
87
|
+
Two opt-in presets are also available: the summary preset (`/structured-gist summary`, alias `session-summary`) and the report preset (`/structured-gist report`, alias `findings`).
|
|
88
|
+
|
|
89
|
+
Trigger phrases: "structured-gist", "sg", "gist mode", "gist this", "outline this", "bullet this", "notes mode", "structure this", "break this down", "distill this", "give me the gist", "make this skimmable", "tighten this up", "condense this".
|
|
90
|
+
|
|
91
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
92
|
+
|
|
93
|
+
## 4. Method
|
|
94
|
+
|
|
95
|
+
The example below compares Claude Opus's unadulterated description of how this skill works vs. the dogfood-ed skill output. It covers the marker taxonomy and overall gist of how `structured-gist` works.
|
|
96
|
+
|
|
97
|
+
As a paragraph, it reads:
|
|
98
|
+
|
|
99
|
+
> structured-gist is a documentation tool that replaces verbose prose summaries with compact outlines, trading paragraphs a reader has to work through for a structure they can take in at a glance. Rather than relying on sentence grammar to carry relationships, it uses a role hierarchy in which each node's position in the tree encodes its meaning: a concept sits at the root, named attributes hang beneath it, ordinal or nominal enumerators sequence the branches, and prose explanations appear only as leaves. Because a format like that decays quickly when written by hand, a linter enforces it with fifteen rules in total. Two representative examples: one flags shallow-depth stalling, where a node occupies a level without contributing any real structure beneath it, and another detects punctuation-spliced facts, where two distinct claims are welded together with a comma or semicolon instead of being split into separate sibling nodes. The linter lives at lint_outline.py, depends only on the standard library, and applies all fifteen rules automatically. It fits session recaps, cause-chain explanations, and GitHub issue and PR comments: anywhere a reader needs to skim a structure rather than parse a paragraph for it.
|
|
100
|
+
|
|
101
|
+
Rendered as an outline at `standard` granularity in `block` mode, the same content drops 68% from 190 to 61 words (list markers not counted). The drop comes from removing connective prose, not from rewording sentences. The tree also cuts parsing cost for the reader, but [Future work](#7-future-work) needs to quantify this.
|
|
102
|
+
|
|
103
|
+
```text
|
|
104
|
+
- structured-gist
|
|
105
|
+
▸ Purpose
|
|
106
|
+
↪ replaces verbose prose summaries with compact
|
|
107
|
+
outlines a reader takes in at a glance
|
|
108
|
+
▸ Mechanism
|
|
109
|
+
↪ role hierarchy, not sentence grammar, carries
|
|
110
|
+
relationships: node position encodes meaning
|
|
111
|
+
▸ Role ladder
|
|
112
|
+
i. concept
|
|
113
|
+
ii. attribute
|
|
114
|
+
iii. enumerator
|
|
115
|
+
iv. explanation
|
|
116
|
+
- Linter
|
|
117
|
+
▸ Rationale
|
|
118
|
+
↪ the format decays quickly when hand-written
|
|
119
|
+
▸ Rules
|
|
120
|
+
a. shallow-depth stalling
|
|
121
|
+
b. punctuation-spliced facts
|
|
122
|
+
▸ Implementation
|
|
123
|
+
a. lint_outline.py
|
|
124
|
+
b. stdlib-only
|
|
125
|
+
- Fit
|
|
126
|
+
A. session recaps
|
|
127
|
+
B. cause-chain explanations
|
|
128
|
+
C. GitHub issue + PR comments
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
There are two active render modes. `block` is the default on all surfaces; `responsive` is opt-in for GitHub issue/PR/comment bodies and chat-app replies. Both are documented, with worked examples, in `skills/structured-gist/SKILL.md` under `## Render modes` and `reference/render-modes.md`.
|
|
132
|
+
|
|
133
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
134
|
+
|
|
135
|
+
## 5. Benchmarks
|
|
136
|
+
|
|
137
|
+
**Key takeaways**
|
|
138
|
+
|
|
139
|
+
- Standard depth keeps most of the meaning. Retention is 0.37 at skim, 0.89 at standard, 0.99 at deep. Since v0.6.0, `standard` is the only shipped level.
|
|
140
|
+
- Shorter is not better. Compression correlates negatively with usefulness (r = -0.75), so it is reported as a cost.
|
|
141
|
+
- Losses come from omission and dropped relations. In round 1, no judged fact was ever reworded into a wrong meaning.
|
|
142
|
+
- On 42 external cases (QMSum, Qasper, HotpotQA), relations are lost more often than facts.
|
|
143
|
+
|
|
144
|
+
Representative measurements from the skill's version history, one metric per column so values in the same column can be compared across versions. Most versions only exercise one metric, so most cells are blank by design (`—`); a filled cell means that version measured that metric. See the [full benchmark ledger](skills/structured-gist/tests/benchmark.md) for methodology and complete history.
|
|
145
|
+
|
|
146
|
+
| Version | Word count | Outline-quality composite | Rules gated | Tests passing | Weighted retention (skim → standard → deep) | Notes |
|
|
147
|
+
|---|---|---|---|---|---|---|
|
|
148
|
+
| v0.2.9 | **147 → 88 (-40.1%)** | — | — | — | — | Dense paragraph vs. skim outline, same content. |
|
|
149
|
+
| v0.3.7 | **19 → 24 (+26.3%)** | — | — | — | — | Block mode vs. responsive mode, same tree; GFM bullet-token artifact, not a regression. |
|
|
150
|
+
| v0.4.0 | — | **0.549 → 0.760** | — | — | — | Direct prompt vs. experimental KG mode, 20-source corpus; KG mode wins structure but loses retention. Not shipped: see [Future work](#7-future-work). |
|
|
151
|
+
| v0.4.2 | — | — | **11 → 15** | **33 → 46** | — | Linter rule coverage. |
|
|
152
|
+
| v0.4.3 | — | — | — | **46 → 63** | — | Rename and trigger-phrase expansion; no rule-logic change. |
|
|
153
|
+
| Eval only (#10) | — | — | — | — | **0.37 → 0.89 → 0.99** | Semantic-compression suite: 8 curated regression/pressure-test cases scored against gold fact lists; Sonnet ran on 8/8, Haiku on 3/8, full-suite Claude Opus run planned. Compression correlated *negatively* with usefulness (**r = -0.75**), so it is reported as a separate cost, never blended into the quality score. |
|
|
154
|
+
|
|
155
|
+
Word count, rule/test coverage, and semantic retention (`skills/structured-gist/benchmarks/semantic-compression/`) are the metrics tracked today. Other metrics (reader comprehension, parse time) remain open; see [Future work](#7-future-work) for status and how to propose one.
|
|
156
|
+
|
|
157
|
+
Third-party dataset licenses and attribution: see [skills/structured-gist/benchmarks/semantic-compression/external-validation/THIRD_PARTY_NOTICES.md](skills/structured-gist/benchmarks/semantic-compression/external-validation/THIRD_PARTY_NOTICES.md).
|
|
158
|
+
|
|
159
|
+
<details>
|
|
160
|
+
<summary>Worked example: registrar-hedge (before / after, recorded Opus rendering at standard granularity)</summary>
|
|
161
|
+
|
|
162
|
+
<!-- README-EXAMPLE:START -->
|
|
163
|
+
### registrar-hedge (Before / After)
|
|
164
|
+
|
|
165
|
+
#### Before (source)
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
Task: migrate the domain acme-studio.com from the old Squarespace site to an
|
|
169
|
+
already-deployed Cloudflare Pages site. Guide me click-by-click; I'll be
|
|
170
|
+
logged into the relevant dashboards and can screen-share tabs.
|
|
171
|
+
|
|
172
|
+
Context:
|
|
173
|
+
- New site: Cloudflare Pages project "acme-studio", live at
|
|
174
|
+
https://acme-studio.pages.dev (direct wrangler uploads, not git-connected).
|
|
175
|
+
Cloudflare account name: personal-account.
|
|
176
|
+
- CRITICAL: the same Cloudflare account also hosts my personal site (project
|
|
177
|
+
"personal-portfolio" / personal-portfolio.pages.dev). Do not touch that project or its DNS.
|
|
178
|
+
- Old site: Squarespace, still live at acme-studio.com. It must remain
|
|
179
|
+
intact as a rollback target for ~2 weeks after cutover. Prefer a DNS-record
|
|
180
|
+
cutover I can revert in minutes; avoid destructive steps (do not cancel the
|
|
181
|
+
Squarespace subscription, do not delete the Squarespace site, do not
|
|
182
|
+
transfer the domain registration itself right now).
|
|
183
|
+
- Registrar is unconfirmed - likely Squarespace Domains (site was built
|
|
184
|
+
there), possibly Google Domains legacy or another registrar. Step 1 is
|
|
185
|
+
identifying it with me (whois + what the Squarespace/Domains dashboard shows).
|
|
186
|
+
|
|
187
|
+
What I need from you, in order:
|
|
188
|
+
1. Identify registrar + current DNS host for acme-studio.com; list current
|
|
189
|
+
DNS records so we have a written rollback snapshot before changing anything.
|
|
190
|
+
2. Decide the cleanest path for pointing apex + www at the Pages project.
|
|
191
|
+
Constraint check: if the DNS stays at Squarespace, confirm whether its DNS
|
|
192
|
+
supports what the apex needs (CNAME flattening/ALIAS); if not, walk me
|
|
193
|
+
through moving just DNS hosting to Cloudflare (add site as a free zone,
|
|
194
|
+
import records, switch nameservers) while keeping registration where it is,
|
|
195
|
+
and note that this weakens the "instant rollback" property - tell me the
|
|
196
|
+
actual rollback procedure and time for whichever path we take.
|
|
197
|
+
3. Lower TTLs first if the current host allows it.
|
|
198
|
+
4. In Cloudflare Pages > acme-studio > Custom domains: add acme-studio.com
|
|
199
|
+
and www.acme-studio.com, then make the DNS changes it prescribes.
|
|
200
|
+
5. Verify: apex + www resolve to the new site over HTTPS, cert issued,
|
|
201
|
+
http->https and www/apex canonicalization work, and
|
|
202
|
+
https://acme-studio.com/about (extensionless) returns 200.
|
|
203
|
+
6. Give me the exact rollback steps as a saved note, and remind me to submit
|
|
204
|
+
the sitemap in Google Search Console after cutover.
|
|
205
|
+
|
|
206
|
+
Known open issue, for your awareness: the site's contact form backend is not
|
|
207
|
+
functional yet (being fixed separately). If we complete DNS today, that's
|
|
208
|
+
accepted - launch decision is mine.
|
|
209
|
+
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### After (structured-gist rendering)
|
|
213
|
+
|
|
214
|
+
```text
|
|
215
|
+
- Domain migration
|
|
216
|
+
▸ Goal
|
|
217
|
+
↪ move acme-studio.com from the old Squarespace site
|
|
218
|
+
to an already-deployed Cloudflare Pages site
|
|
219
|
+
▸ Mode
|
|
220
|
+
↪ guide click-by-click; the user is logged into the
|
|
221
|
+
relevant dashboards and can screen-share tabs
|
|
222
|
+
- New site
|
|
223
|
+
▸ Project
|
|
224
|
+
a. Cloudflare Pages project "acme-studio"
|
|
225
|
+
b. live at https://acme-studio.pages.dev
|
|
226
|
+
▸ Deploy method
|
|
227
|
+
↪ direct wrangler uploads, not git-connected
|
|
228
|
+
▸ Account
|
|
229
|
+
↪ the Cloudflare account name is personal-account
|
|
230
|
+
- Protected project
|
|
231
|
+
▸ Severity
|
|
232
|
+
↪ the user marks this one CRITICAL
|
|
233
|
+
▸ Identity
|
|
234
|
+
a. project "personal-portfolio"
|
|
235
|
+
b. personal-portfolio.pages.dev
|
|
236
|
+
▸ Rule
|
|
237
|
+
↪ the same account hosts it, so do not touch that
|
|
238
|
+
project or its DNS
|
|
239
|
+
- Old site
|
|
240
|
+
▸ State
|
|
241
|
+
↪ Squarespace, still live at acme-studio.com
|
|
242
|
+
▸ Retention
|
|
243
|
+
↪ it must remain intact as a rollback target for
|
|
244
|
+
about two weeks after cutover
|
|
245
|
+
▸ Preference
|
|
246
|
+
↪ prefer a DNS-record cutover revertible in minutes
|
|
247
|
+
▸ Avoid
|
|
248
|
+
a. cancelling the Squarespace subscription
|
|
249
|
+
b. deleting the Squarespace site
|
|
250
|
+
c. transferring the registration right now
|
|
251
|
+
- Registrar unconfirmed
|
|
252
|
+
▸ Candidates
|
|
253
|
+
a. Squarespace Domains, likely
|
|
254
|
+
b. Google Domains legacy, possibly
|
|
255
|
+
c. another registrar
|
|
256
|
+
▸ First step
|
|
257
|
+
↪ identify it with the user, from whois and what
|
|
258
|
+
the Squarespace/Domains dashboard shows
|
|
259
|
+
- Requested steps
|
|
260
|
+
I. identify registrar + current DNS host
|
|
261
|
+
II. decide the apex and www path
|
|
262
|
+
III. lower TTLs first
|
|
263
|
+
IV. add the custom domains in Pages
|
|
264
|
+
V. verify the new site end to end
|
|
265
|
+
VI. rollback note + sitemap reminder
|
|
266
|
+
- Known open issue
|
|
267
|
+
▸ Contact form
|
|
268
|
+
↪ the site's contact form backend is not functional
|
|
269
|
+
yet and is being fixed separately
|
|
270
|
+
▸ Accepted
|
|
271
|
+
↪ completing DNS today is accepted; the launch
|
|
272
|
+
decision is the user's
|
|
273
|
+
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
**Metrics:**
|
|
277
|
+
- Source: 381 words
|
|
278
|
+
- Rendering: 272 words
|
|
279
|
+
- Compression: 28.6%
|
|
280
|
+
|
|
281
|
+
**Key structure:**
|
|
282
|
+
- The registrar hedge is the concept node `Registrar unconfirmed`, so the uncertainty is stated on the node itself
|
|
283
|
+
- Its `▸ Candidates` attribute lists three enumerated children (a./b./c.), each keeping its own qualifier: Squarespace Domains as likely, Google Domains legacy as possibly, and another registrar
|
|
284
|
+
- The `▸ First step` explanation keeps how to identify the registrar: from whois and the Squarespace/Domains dashboard, with the user
|
|
285
|
+
|
|
286
|
+
<!-- README-EXAMPLE:END -->
|
|
287
|
+
|
|
288
|
+
</details>
|
|
289
|
+
|
|
290
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
291
|
+
|
|
292
|
+
## 6. Limitations
|
|
293
|
+
|
|
294
|
+
- **Slop reduction**
|
|
295
|
+
- A. non-deterministic
|
|
296
|
+
- improves skimmability of jargon and em-dash glue, doesn't remove it
|
|
297
|
+
- B. linter scope
|
|
298
|
+
- enforces marker structure only, not sentence quality
|
|
299
|
+
- **Structure vs truth**
|
|
300
|
+
- A. no truth check
|
|
301
|
+
- a well-formed outline can still misrepresent its source content
|
|
302
|
+
- **Single granularity**
|
|
303
|
+
- A. fixed at standard
|
|
304
|
+
- there is no shorter skim view and no exhaustive deep view; both are archived
|
|
305
|
+
|
|
306
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
307
|
+
|
|
308
|
+
## 7. Future work
|
|
309
|
+
|
|
310
|
+
Status and roadmap at 0.9.0:
|
|
311
|
+
|
|
312
|
+
- **Now:** hedge-fidelity axis, waiting on review of the hedge lexicon ([#17](https://github.com/domattioli/structured-gist/issues/17)).
|
|
313
|
+
- **Next:** run the pre-registered controlled benchmark that compares five rendering methods.
|
|
314
|
+
- **Later:** a drill-down mode that expands one node of a rendered outline ([#16](https://github.com/domattioli/structured-gist/issues/16)).
|
|
315
|
+
|
|
316
|
+
- **Explored directions**
|
|
317
|
+
- A. SCU scoring
|
|
318
|
+
- a. semantic content-unit
|
|
319
|
+
- b. compares outline quality to source text
|
|
320
|
+
- c. never formalized into a repeatable benchmark
|
|
321
|
+
- B. JSONL claim-list target
|
|
322
|
+
- a. claim-list-as-replacement rejected
|
|
323
|
+
- recall dropped below the acceptance threshold; the numbers were not preserved
|
|
324
|
+
- b. derived-view renderer shipped v0.4.10
|
|
325
|
+
- `render/claim_list.py`, checked for schema validity only, not recall
|
|
326
|
+
- C. no SKILL.md change
|
|
327
|
+
- neither direction changed the shipped spec
|
|
328
|
+
- D. KG mode (experimental, opt-in)
|
|
329
|
+
- a. typed-graph generation path, validated then rendered linter-clean by construction
|
|
330
|
+
- b. v0.4.0 comparison: wins structure, loses retention (see [Benchmarks](#5-benchmarks))
|
|
331
|
+
- c. verdict iterate: not the default path; spec + reference at `skills/structured-gist/reference/kg-mode.md`
|
|
332
|
+
- **Archived granularity levels**
|
|
333
|
+
- A. skim and deep
|
|
334
|
+
- archived in v0.6.0 at [docs/archive/granularity/](docs/archive/granularity/), with their spec text and examples
|
|
335
|
+
- B. return condition
|
|
336
|
+
- a level comes back only with a controlled benchmark run at that level
|
|
337
|
+
- **Additional benchmark metrics**: word count, rule/test coverage, and semantic retention (see [Benchmarks](#5-benchmarks)) are the tracked metrics today. Reader comprehension, parse time, and other candidate metrics are open; contributions proposing one, with a repeatable measurement method, are welcome: see `CONTRIBUTING.md`.
|
|
338
|
+
|
|
339
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
340
|
+
|
|
341
|
+
## 8. Documentation
|
|
342
|
+
|
|
343
|
+
[skills/structured-gist/SKILL.md](skills/structured-gist/SKILL.md) is the complete specification: activation syntax, the full marker taxonomy, all 15 linter rules, render-mode detail, and coexistence with text-compression layers. [skills/structured-gist/reference/](skills/structured-gist/reference/) holds the extended reference documents it links out to, including [reference/kg-mode.md](skills/structured-gist/reference/kg-mode.md) (the experimental KG generation path, see [Future work](#7-future-work)).
|
|
344
|
+
|
|
345
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
346
|
+
|
|
347
|
+
## 9. Contributing
|
|
348
|
+
|
|
349
|
+
Open an issue first for anything that changes behavior. Small fixes (typos, broken links) can go straight to a pull request. Details: [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
350
|
+
|
|
351
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
352
|
+
|
|
353
|
+
## 10. Reuse and training
|
|
354
|
+
|
|
355
|
+
Apache-2.0 covers redistribution and modification. Beyond that: this repository, its README, and `SKILL.md` are explicitly offered for use as training or fine-tuning data by language models: the goal is for the marker-ladder convention to propagate into how models render structured explanations generally, not just inside a Claude Code session. `llms.txt` at the repo root points a crawler at the pages that matter.
|
|
356
|
+
|
|
357
|
+
<div align="right"><a href="#structured-gist"><sub>^ Back to top</sub></a></div>
|
|
358
|
+
|
|
359
|
+
## 11. License
|
|
360
|
+
|
|
361
|
+
Apache-2.0. See `LICENSE`.
|