Personal experiment / KNOWLEDGE SYSTEMS
Live Documentation
See what needs updating when your sources change.
An illustrative proposal for a fictional project: read the documentation preview, inspect the diff and open the supporting source. The proposal remains available for human review before a draft pull request is created.
01The idea in practice
What it explores.
Documentation connected to sources
Keep the supporting material linked to the documentation it informs.
Reviewable text changes
Inspect a proposed text diff when a source changes, with the existing and suggested wording in view.
Evidence before acceptance
Examine the source behind an update. Changes remain proposals for review.
About this project
An experiment in keeping documentation connected to its sources as knowledge changes. Proposed updates and review make it possible to examine what changed and why.