sllmwiki 1.2.0__tar.gz

sllmwiki-1.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mengjia Sun
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sllmwiki-1.2.0/NOTICE

@@ -0,0 +1,4 @@
+Structural LLM Wiki
+Copyright 2026 Mengjia Sun
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

sllmwiki-1.2.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: sllmwiki
+Version: 1.2.0
+Summary: The Structural LLM Wiki's commands: what the sllmwiki Claude Code plugin runs to keep a wiki of cited narratives in git.
+Author: Mengjia Sun
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mengjiasun1992/structural-llm-wiki
+Project-URL: Documentation, https://github.com/mengjiasun1992/structural-llm-wiki/blob/mainline/docs/manual.md
+Project-URL: Issues, https://github.com/mengjiasun1992/structural-llm-wiki/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Topic :: Documentation
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# {📖} Structural LLM Wiki
+
+![Structural LLM Wiki. You ask your agent one question, "How does the gateway retry?", and your agent does the rest: 1, it finds and saves the sources, a paper, code, a web page, a design doc; 2, it writes the answer, an open book in braces, every claim tied by a thread to its source; 3, it opens one pull request on project-foobar-sllmwiki.git; 4, you review and merge; 5, each release attaches the wiki as a book, in PDF, EPUB and HTML. The repository is git, which your group and their agents clone, share and grow. Answers you can check; written to teach; knowledge that compounds; stays true as sources change; reviewed like code; kept in git, shared as a book.](docs/images/hero.svg)
+
+[![Claude Code plugin](https://img.shields.io/badge/Claude%20Code-plugin-d97757.svg)](#setup)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue.svg)](#setup)
+[![Scripts](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-scripts.yml/badge.svg?branch=mainline)](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-scripts.yml?query=branch%3Amainline)
+[![Book](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-book.yml/badge.svg?branch=mainline)](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-book.yml?query=branch%3Amainline)
+
+**Your group's knowledge, researched by your coding agent, cited to the exact source, and reviewed like code.**
+
+An agent skill, packaged as a Claude Code plugin, that turns a git repository into a wiki your coding agent researches and keeps current. You ask a question. It saves the *sources* that answer it, verbatim copies of code, design docs, specifications, papers or web pages, and writes a *narrative*: an account, told in order, of what happened or how something works, every claim linked to the section of a source that supports it. Each run arrives as one pull request you review. It builds on Andrej Karpathy's [LLM wiki pattern](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) and adds what a group needs: claims you can check, review before anything lands, and a book at each release.
+
+**See one.** Every narrative in [the demo wiki](https://github.com/mengjiasun1992/sllmwiki-demo) was researched and written by an unattended run, and arrived as a pull request to review. Three recent runs, one question each:
+
+| Question | Model | Kind | Sources saved | Narrative | Time | Tokens | Pull request |
+|---|---|---|---|---|---|---|---|
+| [How does Raft elect a leader and keep every server's log consistent?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/how-does-raft-elect-a-leader-and-keep-every-servers-log-consistent.md) | Opus 5.5 | how it works | 3 (99 KB): two dissertation chapters, etcd's README | 1,799 words | 10 min | 6.0M in, 51K out | [#22](https://github.com/mengjiasun1992/sllmwiki-demo/pull/22) |
+| [What are the classic failure modes of large distributed systems, and their mitigations?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/what-are-the-classic-failure-modes-of-large-scale-distributed-systems-and-their-mitigations.md) | Opus 5.5 | survey | 4 (43 KB), and 2 papers as links | 1,937 words | 8 min | 8.7M in, 42K out | [#23](https://github.com/mengjiasun1992/sllmwiki-demo/pull/23) |
+| [How does classic attention compare with paged attention?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/how-does-classic-attention-compare-with-paged-attention-in-transformers.md) | Haiku 5.5 | comparison | 4 (290 KB), and 1 paper as a link | 982 words | 7 min | 4.6M in, 57K out | [#24](https://github.com/mengjiasun1992/sllmwiki-demo/pull/24) |
+
+Each run reports its own time and tokens in its pull request. The tokens count the main session only, and about 98% of the input is cached. Start at [the demo's index](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/.SLLMWIKI_INDICES.md), or download its book as a PDF, EPUB or HTML file from [its latest release](https://github.com/mengjiasun1992/sllmwiki-demo/releases/latest).
+
+## Setup
+
+You need an agent that runs [Agent Skills](https://agentskills.io), such as [Claude Code](https://docs.claude.com/en/docs/claude-code), plus git and Python 3.9 or later; the first run installs the rest, the plugin's code (the [`sllmwiki` package](https://pypi.org/project/sllmwiki/), into the plugin's own folder) and anything missing, with your package manager. [`gh`](https://cli.github.com), signed in, is recommended: it opens the pull requests (without it, the skill prints a link to open each one yourself). The wiki's CI checks and its book need the wiki hosted on GitHub.
+
+1. Create an empty repository (for example `project-foobar-sllmwiki`), clone it and start Claude Code in it.
+2. Install the plugin into it:
+
+   ```bash
+   claude plugin marketplace add mengjiasun1992/structural-llm-wiki --scope project
+   claude plugin install sllmwiki@structural-llm-wiki --scope project
+   ```
+
+3. Run `/sllmwiki:init`. It asks a few preferences (language, source policy, the book), lays out the wiki, installs its CI checks and makes the first commit. Rerun it after a plugin update.
+4. Ask your first questions: `/sllmwiki:build "How does our gateway route requests?" "Why does it retry?"`
+
+**Join a wiki:** clone it, start Claude Code inside, trust the folder and accept the `sllmwiki` plugin it offers. **Other agents** (Codex, Cursor, Copilot): `npx skills add mengjiasun1992/structural-llm-wiki -g` with the [`skills` CLI](https://skills.sh) and `pipx install sllmwiki` (the version the skill's `SKILL.md` names), then ask in your own words ("lint the gateway narratives").
+
+<details>
+<summary>Installing git, Python and gh</summary>
+
+```bash
+brew install git python gh                                   # macOS
+winget install Git.Git Python.Python.3.13 GitHub.cli         # Windows
+sudo apt-get install -y git python3 gh                       # Debian / Ubuntu
+gh auth login && gh auth setup-git                           # then, everywhere
+```
+
+</details>
+
+## Why use it
+
+- **Builders** need to understand a system before they change it, but the why is in a design doc that drifted and a chat thread nobody can find, and an AI's answer can't say which parts it read and which it guessed.
+- **Tech leads** need what the group knows to outlive who knows it. Onboarding runs through the same few seniors, and nobody can say which docs are still true.
+- **Researchers** have more papers than time, and LLM summaries cite sections that don't say what they claim.
+
+What the wiki does about it:
+
+- **Every claim can be checked.** Each one cites the exact section of a saved source, one click away. What no source states is marked as the narrative's own reasoning (`[→]`) or as a gap (`[?]`), never filled with a guess. Lint checks every claim and quotation against the section it cites.
+- **Nothing lands unreviewed.** The agent researches on its own and delivers one pull request: a checklist on top, the decisions it couldn't make, and what the run cost. Your seniors review instead of writing from scratch.
+- **Knowledge compounds.** One narrative per question, kept in git. A new answer builds on what the wiki already explains, and the next person who asks gets the reviewed answer.
+- **Answers stay true.** Each narrative records the source versions it read. When code or a doc changes, exactly the narratives that rest on it are flagged.
+- **It teaches.** The answer's shape fits the question, written for a reader new to the topic; describe your own kind, such as a postmortem or a ten-minute primer on a paper.
+- **It knows who to ask.** Each topic lists the people behind its code and docs, ranked by evidence from git history and code owners.
+- **A book with every release.** The whole wiki as a PDF, an EPUB or one HTML file, chapters in teaching order, diagrams and math drawn as on GitHub: an onboarding pack, current as of that day.
+
+![Every kind of question gets the shape that teaches it. What is X? In short, then rigorously, and its edge cases. How does X work? One real example, walked through with its numbers. Principles of X? The field mapped first, then each idea in brief. X or Y? Every option compared, and the rule for when each wins. What happened? The timeline, the chain of causes, and the lessons. Your own kind? A postmortem, a primer: a template you describe.](docs/images/answer-shapes.svg)
+
+It's all plain Markdown and YAML in git: browse it on GitHub, open it in Obsidian, or use it from any agent that supports Agent Skills. Scripts do everything mechanical, so your tokens go to judgment.
+
+## Usage
+
+![Four moments, from your side. Ask anything: an answer in seconds, each claim cited, and who to ask. Grow it by asking: it researches while you're away, and you review one pull request; nothing lands till you merge. It stays true: when a source changes, exactly the answers that rest on it are flagged, and the rest stay untouched. Share it as a book: each release, such as v2026.10.24, attaches the whole wiki as a PDF to print and share, an EPUB for e-readers and phones, and one HTML file for a browser; read it offline, or hand it on.](docs/images/four-moments.svg)
+
+| I want to… | Run |
+|---|---|
+| Set up a wiki (start here, in an empty repository) | `/sllmwiki:init` |
+| Ask the wiki: a cited answer in seconds, or a DRAFT and an offer to research it | `/sllmwiki:query "How does the gateway retry failed backends?"` |
+| Research questions unattended: sources saved, a cited answer each, one pull request to review | `/sllmwiki:build "How does the gateway route requests?" "Why does it retry?"` |
+| Publish the wiki as a book (PDF, EPUB, HTML) in a dated release | `/sllmwiki:release` |
+
+Everything else, ask in your own words: "Lint the gateway narratives", "Who knows the gateway?", "Make a template for postmortems of our incidents", or "What can sllmwiki do?".
+
+**[The manual](docs/manual.md)** has the rest: reviewing a run, what's in your wiki, templates, citations, books, settings, languages, Obsidian, teams, and an FAQ.
+
+## Licenses and your data
+
+The skill is open source under the [Apache License 2.0](LICENSE); your wiki is yours, and each source stays its authors', kept with its URL and license, quoted briefly, never fetched past a login or paywall. Narratives are written by an LLM: every claim is cited, but review each pull request before you merge it. The plugin runs on your machine and its authors collect nothing ([Privacy](PRIVACY.md)). The details: [the manual, §12](docs/manual.md#12-licenses-sources-and-your-responsibility).
+
+## Design
+
+[docs/structural_llm_wiki_design.md](docs/structural_llm_wiki_design.md) has the architecture and the decisions behind it, and [docs/book_design.md](docs/book_design.md) the book a release attaches. [docs/skill_execution_plan.md](docs/skill_execution_plan.md) and [docs/book_execution_plan.md](docs/book_execution_plan.md) say how each was built.
+
+## Developing
+
+```text
+plugin/                the plugin: instructions only
+├── skills/sllmwiki/   the skill: SKILL.md, workflows/, steps/
+└── commands/          Claude Code commands: init, query, build, release
+src/sllmwiki/          the sllmwiki package: every command, lib/, templates/
+tests/                 unit tests for the package
+src/actions/           the GitHub actions a wiki's CI calls
+src/tools/             development and CI tools (eval-plugin.sh, check-yaml, check-book)
+evals/                 behavior evals, run through src/tools/eval-plugin.sh
+docs/                  the manual, the designs, their plans, and their figures
+```
+
+`AGENTS.md` has the rules for changing this repository: tests with every logic change and coverage at 95% or above, instruction word budgets, evals for behavior changes. Run the tests, and try the plugin from a checkout:
+
+```bash
+python3 -m venv .venv && . .venv/bin/activate
+python3 -m pip install -e . "coverage[toml]==7.6.10"
+python3 tests/run.py --coverage
+claude --plugin-dir plugin             # runs the sllmwiki on PATH: this checkout's
+```
+
+## License
+
+Copyright 2026 Mengjia Sun. Licensed under the [Apache License, Version 2.0](LICENSE); see [NOTICE](NOTICE).

sllmwiki-1.2.0/README.md

@@ -0,0 +1,122 @@
+# {📖} Structural LLM Wiki
+
+![Structural LLM Wiki. You ask your agent one question, "How does the gateway retry?", and your agent does the rest: 1, it finds and saves the sources, a paper, code, a web page, a design doc; 2, it writes the answer, an open book in braces, every claim tied by a thread to its source; 3, it opens one pull request on project-foobar-sllmwiki.git; 4, you review and merge; 5, each release attaches the wiki as a book, in PDF, EPUB and HTML. The repository is git, which your group and their agents clone, share and grow. Answers you can check; written to teach; knowledge that compounds; stays true as sources change; reviewed like code; kept in git, shared as a book.](docs/images/hero.svg)
+
+[![Claude Code plugin](https://img.shields.io/badge/Claude%20Code-plugin-d97757.svg)](#setup)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue.svg)](#setup)
+[![Scripts](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-scripts.yml/badge.svg?branch=mainline)](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-scripts.yml?query=branch%3Amainline)
+[![Book](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-book.yml/badge.svg?branch=mainline)](https://github.com/mengjiasun1992/structural-llm-wiki/actions/workflows/check-book.yml?query=branch%3Amainline)
+
+**Your group's knowledge, researched by your coding agent, cited to the exact source, and reviewed like code.**
+
+An agent skill, packaged as a Claude Code plugin, that turns a git repository into a wiki your coding agent researches and keeps current. You ask a question. It saves the *sources* that answer it, verbatim copies of code, design docs, specifications, papers or web pages, and writes a *narrative*: an account, told in order, of what happened or how something works, every claim linked to the section of a source that supports it. Each run arrives as one pull request you review. It builds on Andrej Karpathy's [LLM wiki pattern](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) and adds what a group needs: claims you can check, review before anything lands, and a book at each release.
+
+**See one.** Every narrative in [the demo wiki](https://github.com/mengjiasun1992/sllmwiki-demo) was researched and written by an unattended run, and arrived as a pull request to review. Three recent runs, one question each:
+
+| Question | Model | Kind | Sources saved | Narrative | Time | Tokens | Pull request |
+|---|---|---|---|---|---|---|---|
+| [How does Raft elect a leader and keep every server's log consistent?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/how-does-raft-elect-a-leader-and-keep-every-servers-log-consistent.md) | Opus 5.5 | how it works | 3 (99 KB): two dissertation chapters, etcd's README | 1,799 words | 10 min | 6.0M in, 51K out | [#22](https://github.com/mengjiasun1992/sllmwiki-demo/pull/22) |
+| [What are the classic failure modes of large distributed systems, and their mitigations?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/what-are-the-classic-failure-modes-of-large-scale-distributed-systems-and-their-mitigations.md) | Opus 5.5 | survey | 4 (43 KB), and 2 papers as links | 1,937 words | 8 min | 8.7M in, 42K out | [#23](https://github.com/mengjiasun1992/sllmwiki-demo/pull/23) |
+| [How does classic attention compare with paged attention?](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/narratives/how-does-classic-attention-compare-with-paged-attention-in-transformers.md) | Haiku 5.5 | comparison | 4 (290 KB), and 1 paper as a link | 982 words | 7 min | 4.6M in, 57K out | [#24](https://github.com/mengjiasun1992/sllmwiki-demo/pull/24) |
+
+Each run reports its own time and tokens in its pull request. The tokens count the main session only, and about 98% of the input is cached. Start at [the demo's index](https://github.com/mengjiasun1992/sllmwiki-demo/blob/main/sllmwiki/.SLLMWIKI_INDICES.md), or download its book as a PDF, EPUB or HTML file from [its latest release](https://github.com/mengjiasun1992/sllmwiki-demo/releases/latest).
+
+## Setup
+
+You need an agent that runs [Agent Skills](https://agentskills.io), such as [Claude Code](https://docs.claude.com/en/docs/claude-code), plus git and Python 3.9 or later; the first run installs the rest, the plugin's code (the [`sllmwiki` package](https://pypi.org/project/sllmwiki/), into the plugin's own folder) and anything missing, with your package manager. [`gh`](https://cli.github.com), signed in, is recommended: it opens the pull requests (without it, the skill prints a link to open each one yourself). The wiki's CI checks and its book need the wiki hosted on GitHub.
+
+1. Create an empty repository (for example `project-foobar-sllmwiki`), clone it and start Claude Code in it.
+2. Install the plugin into it:
+
+   ```bash
+   claude plugin marketplace add mengjiasun1992/structural-llm-wiki --scope project
+   claude plugin install sllmwiki@structural-llm-wiki --scope project
+   ```
+
+3. Run `/sllmwiki:init`. It asks a few preferences (language, source policy, the book), lays out the wiki, installs its CI checks and makes the first commit. Rerun it after a plugin update.
+4. Ask your first questions: `/sllmwiki:build "How does our gateway route requests?" "Why does it retry?"`
+
+**Join a wiki:** clone it, start Claude Code inside, trust the folder and accept the `sllmwiki` plugin it offers. **Other agents** (Codex, Cursor, Copilot): `npx skills add mengjiasun1992/structural-llm-wiki -g` with the [`skills` CLI](https://skills.sh) and `pipx install sllmwiki` (the version the skill's `SKILL.md` names), then ask in your own words ("lint the gateway narratives").
+
+<details>
+<summary>Installing git, Python and gh</summary>
+
+```bash
+brew install git python gh                                   # macOS
+winget install Git.Git Python.Python.3.13 GitHub.cli         # Windows
+sudo apt-get install -y git python3 gh                       # Debian / Ubuntu
+gh auth login && gh auth setup-git                           # then, everywhere
+```
+
+</details>
+
+## Why use it
+
+- **Builders** need to understand a system before they change it, but the why is in a design doc that drifted and a chat thread nobody can find, and an AI's answer can't say which parts it read and which it guessed.
+- **Tech leads** need what the group knows to outlive who knows it. Onboarding runs through the same few seniors, and nobody can say which docs are still true.
+- **Researchers** have more papers than time, and LLM summaries cite sections that don't say what they claim.
+
+What the wiki does about it:
+
+- **Every claim can be checked.** Each one cites the exact section of a saved source, one click away. What no source states is marked as the narrative's own reasoning (`[→]`) or as a gap (`[?]`), never filled with a guess. Lint checks every claim and quotation against the section it cites.
+- **Nothing lands unreviewed.** The agent researches on its own and delivers one pull request: a checklist on top, the decisions it couldn't make, and what the run cost. Your seniors review instead of writing from scratch.
+- **Knowledge compounds.** One narrative per question, kept in git. A new answer builds on what the wiki already explains, and the next person who asks gets the reviewed answer.
+- **Answers stay true.** Each narrative records the source versions it read. When code or a doc changes, exactly the narratives that rest on it are flagged.
+- **It teaches.** The answer's shape fits the question, written for a reader new to the topic; describe your own kind, such as a postmortem or a ten-minute primer on a paper.
+- **It knows who to ask.** Each topic lists the people behind its code and docs, ranked by evidence from git history and code owners.
+- **A book with every release.** The whole wiki as a PDF, an EPUB or one HTML file, chapters in teaching order, diagrams and math drawn as on GitHub: an onboarding pack, current as of that day.
+
+![Every kind of question gets the shape that teaches it. What is X? In short, then rigorously, and its edge cases. How does X work? One real example, walked through with its numbers. Principles of X? The field mapped first, then each idea in brief. X or Y? Every option compared, and the rule for when each wins. What happened? The timeline, the chain of causes, and the lessons. Your own kind? A postmortem, a primer: a template you describe.](docs/images/answer-shapes.svg)
+
+It's all plain Markdown and YAML in git: browse it on GitHub, open it in Obsidian, or use it from any agent that supports Agent Skills. Scripts do everything mechanical, so your tokens go to judgment.
+
+## Usage
+
+![Four moments, from your side. Ask anything: an answer in seconds, each claim cited, and who to ask. Grow it by asking: it researches while you're away, and you review one pull request; nothing lands till you merge. It stays true: when a source changes, exactly the answers that rest on it are flagged, and the rest stay untouched. Share it as a book: each release, such as v2026.10.24, attaches the whole wiki as a PDF to print and share, an EPUB for e-readers and phones, and one HTML file for a browser; read it offline, or hand it on.](docs/images/four-moments.svg)
+
+| I want to… | Run |
+|---|---|
+| Set up a wiki (start here, in an empty repository) | `/sllmwiki:init` |
+| Ask the wiki: a cited answer in seconds, or a DRAFT and an offer to research it | `/sllmwiki:query "How does the gateway retry failed backends?"` |
+| Research questions unattended: sources saved, a cited answer each, one pull request to review | `/sllmwiki:build "How does the gateway route requests?" "Why does it retry?"` |
+| Publish the wiki as a book (PDF, EPUB, HTML) in a dated release | `/sllmwiki:release` |
+
+Everything else, ask in your own words: "Lint the gateway narratives", "Who knows the gateway?", "Make a template for postmortems of our incidents", or "What can sllmwiki do?".
+
+**[The manual](docs/manual.md)** has the rest: reviewing a run, what's in your wiki, templates, citations, books, settings, languages, Obsidian, teams, and an FAQ.
+
+## Licenses and your data
+
+The skill is open source under the [Apache License 2.0](LICENSE); your wiki is yours, and each source stays its authors', kept with its URL and license, quoted briefly, never fetched past a login or paywall. Narratives are written by an LLM: every claim is cited, but review each pull request before you merge it. The plugin runs on your machine and its authors collect nothing ([Privacy](PRIVACY.md)). The details: [the manual, §12](docs/manual.md#12-licenses-sources-and-your-responsibility).
+
+## Design
+
+[docs/structural_llm_wiki_design.md](docs/structural_llm_wiki_design.md) has the architecture and the decisions behind it, and [docs/book_design.md](docs/book_design.md) the book a release attaches. [docs/skill_execution_plan.md](docs/skill_execution_plan.md) and [docs/book_execution_plan.md](docs/book_execution_plan.md) say how each was built.
+
+## Developing
+
+```text
+plugin/                the plugin: instructions only
+├── skills/sllmwiki/   the skill: SKILL.md, workflows/, steps/
+└── commands/          Claude Code commands: init, query, build, release
+src/sllmwiki/          the sllmwiki package: every command, lib/, templates/
+tests/                 unit tests for the package
+src/actions/           the GitHub actions a wiki's CI calls
+src/tools/             development and CI tools (eval-plugin.sh, check-yaml, check-book)
+evals/                 behavior evals, run through src/tools/eval-plugin.sh
+docs/                  the manual, the designs, their plans, and their figures
+```
+
+`AGENTS.md` has the rules for changing this repository: tests with every logic change and coverage at 95% or above, instruction word budgets, evals for behavior changes. Run the tests, and try the plugin from a checkout:
+
+```bash
+python3 -m venv .venv && . .venv/bin/activate
+python3 -m pip install -e . "coverage[toml]==7.6.10"
+python3 tests/run.py --coverage
+claude --plugin-dir plugin             # runs the sllmwiki on PATH: this checkout's
+```
+
+## License
+
+Copyright 2026 Mengjia Sun. Licensed under the [Apache License, Version 2.0](LICENSE); see [NOTICE](NOTICE).

sllmwiki-1.2.0/pyproject.toml

@@ -0,0 +1,63 @@
+# The sllmwiki package (src/sllmwiki/), which the plugin installs and runs as `sllmwiki <command>`,
+# and the lint and coverage configuration for it and src/tools/.
+# The scripts use only the standard library and support Python 3.9.
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sllmwiki"
+dynamic = ["version"]
+description = "The Structural LLM Wiki's commands: what the sllmwiki Claude Code plugin runs to keep a wiki of cited narratives in git."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Mengjia Sun" }]
+dependencies = []  # the standard library only
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Environment :: Console",
+  "Topic :: Documentation",
+]
+
+[project.urls]
+Homepage = "https://github.com/mengjiasun1992/structural-llm-wiki"
+Documentation = "https://github.com/mengjiasun1992/structural-llm-wiki/blob/mainline/docs/manual.md"
+Issues = "https://github.com/mengjiasun1992/structural-llm-wiki/issues"
+
+[project.scripts]
+sllmwiki = "sllmwiki.cli:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "sllmwiki.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["sllmwiki*"]
+
+[tool.setuptools.package-data]
+# the templates: what init installs (dotfiles included), the narrative templates and language packs, the book's
+sllmwiki = ["templates/**/*", "templates/**/.*", "templates/**/.*/*", "templates/**/.*/**/*"]
+
+[tool.ruff]
+target-version = "py39"
+line-length = 200
+
+[tool.ruff.lint]
+# pyflakes and pycodestyle errors (the defaults), plus bugbear for likely bugs.
+select = ["E4", "E7", "E9", "F", "B"]
+# E741 (ambiguous name): the scripts name a line `l` throughout, by convention.
+ignore = ["E741"]
+
+[tool.coverage.run]
+# Line coverage of the skill's scripts; the tests live in tests/.
+source = ["src/sllmwiki"]
+omit = ["*/__init__.py"]
+
+[tool.coverage.report]
+fail_under = 95
+show_missing = true
+skip_covered = true

sllmwiki-1.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sllmwiki-1.2.0/src/sllmwiki/__init__.py

@@ -0,0 +1,8 @@
+"""sllmwiki: the Structural LLM Wiki's code. The plugin's instructions run it as
+`sllmwiki <command>`; a wiki's GitHub Actions run it from this repository at the tag."""
+
+import os
+
+__version__ = '1.2.0'  # the plugin's version too (.claude-plugin/plugin.json); a test keeps them equal
+
+TEMPLATES = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'templates')  # what init installs, the narrative templates, the book's

sllmwiki-1.2.0/src/sllmwiki/__main__.py

@@ -0,0 +1,7 @@
+"""python3 -m sllmwiki <command> ...: the same as the sllmwiki command."""
+
+import sys
+
+from sllmwiki.cli import main
+
+sys.exit(main())

sllmwiki-1.2.0/src/sllmwiki/cli.py

@@ -0,0 +1,31 @@
+"""sllmwiki: the Structural LLM Wiki's commands.
+
+  sllmwiki <command> [<args>]   run one; sllmwiki <command> --help explains it
+  sllmwiki --version            this package's version, the plugin's too
+"""
+
+import importlib
+import sys
+
+from sllmwiki import __version__
+from sllmwiki.lib.util import setup_stdio
+
+COMMANDS = ('book', 'check-upstream', 'cited-sections', 'contributors', 'doctor', 'fetch-source', 'finish-narrative', 'init', 'manifest',
+            'narrative-format', 'publish', 'reading-plan', 'release', 'review-checklist', 'search', 'tag-tree', 'wiki-check')
+
+
+def main(argv=None):
+    """Run `sllmwiki <command> <args>`; its exit code. 2 for an unknown command."""
+    argv = sys.argv[1:] if argv is None else list(argv)
+    setup_stdio()
+    if argv[:1] == ['--version']:
+        print(f'sllmwiki {__version__}')
+        return 0
+    if not argv or argv[0] in ('-h', '--help'):
+        print(__doc__.strip() + '\n\ncommands: ' + ', '.join(COMMANDS))
+        return 0 if argv else 2
+    if argv[0] not in COMMANDS:
+        print(f"sllmwiki: no command {argv[0]!r}; the commands: {', '.join(COMMANDS)}", file=sys.stderr)
+        return 2
+    module = importlib.import_module('sllmwiki.commands.' + argv[0].replace('-', '_'))
+    return module.main(argv[1:])

sllmwiki-1.2.0/src/sllmwiki/commands/__init__.py

@@ -0,0 +1 @@
+"""One module per `sllmwiki <command>`, each with main(argv)."""