portolano 0.1.0__tar.gz

portolano-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+# working notes, never published
+.notes/
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+
+# tooling
+.pytest_cache/
+.ruff_cache/
+.idea/
+.vscode/

portolano-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 Gabriele Brosulo
+
+   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.

portolano-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.5
+Name: portolano
+Version: 0.1.0
+Summary: Project knowledge your coding agent writes, reads and keeps honest - and that knows when it has gone out of date.
+Project-URL: Homepage, https://github.com/g4b0/portolano
+Project-URL: Documentation, https://github.com/g4b0/portolano/tree/main/docs
+Project-URL: Issues, https://github.com/g4b0/portolano/issues
+Author: Gabriele Brosulo
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents-md,coding-agents,context-rot,documentation,wiki
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# Portolano
+
+**Project knowledge your coding agent writes, reads and keeps honest — and that knows when it has gone out of date.**
+
+> A *portolano* was the book of sailing directions: what you see from the deck, where the shoals are, which bearing to hold. Portolan charts were the first maps drawn from real compass bearings instead of theory — made by sailors who had already sailed that coast, for the ones who would sail it next.
+>
+> **Your codebase is the coast. Portolano is the book the last crew left you.**
+
+---
+
+## The problem, in one paragraph
+
+An agent can read your code. It cannot read *why* the code is that way, what was tried and abandoned, which deploy step bites, or where one module's responsibility ends. So every session pays to re-derive what it can, and guesses the rest. The usual fix — a `CLAUDE.md` or `AGENTS.md` describing the project — rots: Treude and Baltes call this **context rot**, *"the gradual divergence between what a configuration file says about a codebase, its tools, its architecture, or its conventions, and what actually holds"*, and found stale references in **23% of 356 sampled repositories** ([arXiv:2606.09090](https://arxiv.org/abs/2606.09090)).
+
+Portolano's answer is one idea: **every page records the commit it was checked against and the paths it describes.** Staleness stops being a virtue you're supposed to remember and becomes a query you can run.
+
+---
+
+## What it's for
+
+Three payoffs, and the third is the one that pays for the other two.
+
+| Who gains | What they get |
+|---|---|
+| **For the agent** | it reads an index and one page instead of grepping its way across the repository. The knowledge is already distilled, so it does not re-derive it every session |
+| **For you** | one place to look. Point your editor at the wiki root and the code sits underneath it as submodules — wiki and source open in the same window, in the same search |
+| **For the project** | documentation that is *organised* rather than *accumulated*: a catalog, one page per subject, and a rule for when each page stops being true |
+
+**The token argument is the concrete one.** Re-deriving how a subsystem works costs thousands of tokens and produces nothing durable; reading a page costs a few hundred and the page stays. Measured on the same four queries against the same domain, a persistent knowledge layer used **47K tokens where a retrieval baseline used 305K** ([arXiv:2604.11243](https://arxiv.org/abs/2604.11243)).
+
+The saving compounds, which is why the freshness contract matters: a wiki nobody trusts gets re-derived anyway, and then you have paid twice.
+
+---
+
+## The whole idea, in one example
+
+A page in the wiki:
+
+```markdown
+---
+title: Notification dispatch
+slug: notifications/dispatch
+type: reference
+status: active
+summary: How queued notifications are fanned out to email, SMS and push.
+related: [queue/workers]
+updated: 2026-01-14
+verified-at: 4312f47                       # the commit this was checked against
+covers: [src/services/notification/**]     # what this page describes
+---
+
+# Notification dispatch
+
+## What it does
+Fans a queued notification out to every channel the user has enabled.
+
+## Where it lives
+| Concern | Location |
+|---|---|
+| entry point | `src/services/notification/Dispatcher.php:42` |
+
+## Gotchas
+- Retries are **not** idempotent below the channel layer — a requeue can send twice.
+```
+
+A month later, ask the page whether it is still true:
+
+```bash
+git log --oneline 4312f47..HEAD -- ':(glob)src/services/notification/**'
+```
+
+| Output | Meaning | What you do |
+|---|---|---|
+| empty | nothing it describes moved | nothing. Costs nothing |
+| some commits | the page is **suspect**, not wrong | read them, fix the page, advance `verified-at` |
+
+That is the entire mechanism. No service, no database, no index to host: **git is the database**, and the check is one command. Everything else in Portolano is convention around this one move.
+
+---
+
+## Starting from nothing
+
+You do not write the first page by hand. `portolano bootstrap` measures every repository in the workspace — how many files git tracks, which top-level areas exist, which commit it sits on — and writes one brief per wiki into `briefs/`, each telling your agent **how high to fly**: read the entry points of a small repository, name the areas of a large one, read no implementation at all in a huge one.
+
+It asks for one page: what the repository is, how it is laid out, and what it did not look at. That last list is the queue for everything after.
+
+**Portolano makes no model calls, here or anywhere.** The brief is text you hand to whichever agent you use. What the command contributes is the measuring — the part an agent guesses badly and git answers exactly.
+
+---
+
+## Why it is built this way
+
+| Principle | What it means in practice |
+|---|---|
+| **Concepts, not code** | the code is readable; a page that narrates it is rot waiting to happen. Pages hold what the code cannot say — the why, the boundary, the trap |
+| **KISS, literally** | anything that would need a daemon, a server or an account is out by design |
+| **Router, not manual** | the always-loaded file says *which wiki governs what*, and nothing else. Knowledge is fetched from an index on demand, not preloaded into every prompt |
+| **Suspect, not repaired** | the mechanism finds candidates; the judgement stays yours. A page that was auto-corrected is a page nobody re-read |
+| **Vendor-neutral** | `AGENTS.md` is the source; `CLAUDE.md` and friends are generated |
+| **Not just for new code** | a page can be written today about code written five years ago. Nothing needs to have been done right at the time |
+
+---
+
+## Where to go next
+
+| Page | What is in it |
+|---|---|
+| 🚀 [**Quickstart**](https://github.com/g4b0/portolano/blob/main/docs/quickstart.md) | a working wiki in about ten minutes |
+| 📖 [**Format reference**](https://github.com/g4b0/portolano/blob/main/docs/format.md) | frontmatter, vocabularies, linking, length rules — the wiki about the wiki |
+| 🔭 [**Prior art**](https://github.com/g4b0/portolano/blob/main/docs/prior-art.md) | where this sits in the literature and among existing tools |
+
+---
+
+## Background
+
+Three references worth knowing, and they are not the same thing:
+
+| Reference | What it contributes |
+|---|---|
+| [Karpathy's *llm-wiki* gist](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) (Apr 2026) | the **method**: let the model keep a wiki, so what it learns accumulates instead of evaporating. Portolano points that method at a target that moves |
+| [Treude & Baltes, *Context Rot*](https://arxiv.org/abs/2606.09090) (Jun 2026) | the **problem**, defined and measured for the code setting, plus a research roadmap. Portolano is one answer to the preventive mitigation they list as an open question |
+| [*Agent READMEs*, ACM TOSEM](https://doi.org/10.1145/3840295) (2026) | the **evidence**: across 2,303 context files, these are not static documentation but artifacts that grow like configuration code through frequent small additions. Which is why the router stays thin |
+
+---
+
+**Status:** v0 — the format is settled enough to use and still expected to move. See [prior art](https://github.com/g4b0/portolano/blob/main/docs/prior-art.md) for what is and isn't new here.
+
+**License:** [Apache-2.0](https://github.com/g4b0/portolano/blob/main/LICENSE).

portolano-0.1.0/README.md

@@ -0,0 +1,128 @@
+# Portolano
+
+**Project knowledge your coding agent writes, reads and keeps honest — and that knows when it has gone out of date.**
+
+> A *portolano* was the book of sailing directions: what you see from the deck, where the shoals are, which bearing to hold. Portolan charts were the first maps drawn from real compass bearings instead of theory — made by sailors who had already sailed that coast, for the ones who would sail it next.
+>
+> **Your codebase is the coast. Portolano is the book the last crew left you.**
+
+---
+
+## The problem, in one paragraph
+
+An agent can read your code. It cannot read *why* the code is that way, what was tried and abandoned, which deploy step bites, or where one module's responsibility ends. So every session pays to re-derive what it can, and guesses the rest. The usual fix — a `CLAUDE.md` or `AGENTS.md` describing the project — rots: Treude and Baltes call this **context rot**, *"the gradual divergence between what a configuration file says about a codebase, its tools, its architecture, or its conventions, and what actually holds"*, and found stale references in **23% of 356 sampled repositories** ([arXiv:2606.09090](https://arxiv.org/abs/2606.09090)).
+
+Portolano's answer is one idea: **every page records the commit it was checked against and the paths it describes.** Staleness stops being a virtue you're supposed to remember and becomes a query you can run.
+
+---
+
+## What it's for
+
+Three payoffs, and the third is the one that pays for the other two.
+
+| Who gains | What they get |
+|---|---|
+| **For the agent** | it reads an index and one page instead of grepping its way across the repository. The knowledge is already distilled, so it does not re-derive it every session |
+| **For you** | one place to look. Point your editor at the wiki root and the code sits underneath it as submodules — wiki and source open in the same window, in the same search |
+| **For the project** | documentation that is *organised* rather than *accumulated*: a catalog, one page per subject, and a rule for when each page stops being true |
+
+**The token argument is the concrete one.** Re-deriving how a subsystem works costs thousands of tokens and produces nothing durable; reading a page costs a few hundred and the page stays. Measured on the same four queries against the same domain, a persistent knowledge layer used **47K tokens where a retrieval baseline used 305K** ([arXiv:2604.11243](https://arxiv.org/abs/2604.11243)).
+
+The saving compounds, which is why the freshness contract matters: a wiki nobody trusts gets re-derived anyway, and then you have paid twice.
+
+---
+
+## The whole idea, in one example
+
+A page in the wiki:
+
+```markdown
+---
+title: Notification dispatch
+slug: notifications/dispatch
+type: reference
+status: active
+summary: How queued notifications are fanned out to email, SMS and push.
+related: [queue/workers]
+updated: 2026-01-14
+verified-at: 4312f47                       # the commit this was checked against
+covers: [src/services/notification/**]     # what this page describes
+---
+
+# Notification dispatch
+
+## What it does
+Fans a queued notification out to every channel the user has enabled.
+
+## Where it lives
+| Concern | Location |
+|---|---|
+| entry point | `src/services/notification/Dispatcher.php:42` |
+
+## Gotchas
+- Retries are **not** idempotent below the channel layer — a requeue can send twice.
+```
+
+A month later, ask the page whether it is still true:
+
+```bash
+git log --oneline 4312f47..HEAD -- ':(glob)src/services/notification/**'
+```
+
+| Output | Meaning | What you do |
+|---|---|---|
+| empty | nothing it describes moved | nothing. Costs nothing |
+| some commits | the page is **suspect**, not wrong | read them, fix the page, advance `verified-at` |
+
+That is the entire mechanism. No service, no database, no index to host: **git is the database**, and the check is one command. Everything else in Portolano is convention around this one move.
+
+---
+
+## Starting from nothing
+
+You do not write the first page by hand. `portolano bootstrap` measures every repository in the workspace — how many files git tracks, which top-level areas exist, which commit it sits on — and writes one brief per wiki into `briefs/`, each telling your agent **how high to fly**: read the entry points of a small repository, name the areas of a large one, read no implementation at all in a huge one.
+
+It asks for one page: what the repository is, how it is laid out, and what it did not look at. That last list is the queue for everything after.
+
+**Portolano makes no model calls, here or anywhere.** The brief is text you hand to whichever agent you use. What the command contributes is the measuring — the part an agent guesses badly and git answers exactly.
+
+---
+
+## Why it is built this way
+
+| Principle | What it means in practice |
+|---|---|
+| **Concepts, not code** | the code is readable; a page that narrates it is rot waiting to happen. Pages hold what the code cannot say — the why, the boundary, the trap |
+| **KISS, literally** | anything that would need a daemon, a server or an account is out by design |
+| **Router, not manual** | the always-loaded file says *which wiki governs what*, and nothing else. Knowledge is fetched from an index on demand, not preloaded into every prompt |
+| **Suspect, not repaired** | the mechanism finds candidates; the judgement stays yours. A page that was auto-corrected is a page nobody re-read |
+| **Vendor-neutral** | `AGENTS.md` is the source; `CLAUDE.md` and friends are generated |
+| **Not just for new code** | a page can be written today about code written five years ago. Nothing needs to have been done right at the time |
+
+---
+
+## Where to go next
+
+| Page | What is in it |
+|---|---|
+| 🚀 [**Quickstart**](https://github.com/g4b0/portolano/blob/main/docs/quickstart.md) | a working wiki in about ten minutes |
+| 📖 [**Format reference**](https://github.com/g4b0/portolano/blob/main/docs/format.md) | frontmatter, vocabularies, linking, length rules — the wiki about the wiki |
+| 🔭 [**Prior art**](https://github.com/g4b0/portolano/blob/main/docs/prior-art.md) | where this sits in the literature and among existing tools |
+
+---
+
+## Background
+
+Three references worth knowing, and they are not the same thing:
+
+| Reference | What it contributes |
+|---|---|
+| [Karpathy's *llm-wiki* gist](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) (Apr 2026) | the **method**: let the model keep a wiki, so what it learns accumulates instead of evaporating. Portolano points that method at a target that moves |
+| [Treude & Baltes, *Context Rot*](https://arxiv.org/abs/2606.09090) (Jun 2026) | the **problem**, defined and measured for the code setting, plus a research roadmap. Portolano is one answer to the preventive mitigation they list as an open question |
+| [*Agent READMEs*, ACM TOSEM](https://doi.org/10.1145/3840295) (2026) | the **evidence**: across 2,303 context files, these are not static documentation but artifacts that grow like configuration code through frequent small additions. Which is why the router stays thin |
+
+---
+
+**Status:** v0 — the format is settled enough to use and still expected to move. See [prior art](https://github.com/g4b0/portolano/blob/main/docs/prior-art.md) for what is and isn't new here.
+
+**License:** [Apache-2.0](https://github.com/g4b0/portolano/blob/main/LICENSE).