Refactor documentation of properties #986
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This closes issue #965.
Copilot Generated Description
This pull request removes the outdated
Properties.mdsummary file and replaces it with individual markdown files for each formally stated or proved property in the ledger specification. Each property now has its own dedicated documentation page, with improved cross-referencing and explicit section anchors for easier navigation. The changes also update the navigation and link references to reflect this new structure.Documentation Restructuring:
Properties.mdsummary file from both the documentation sources and navigation, eliminating the previous aggregation of ledger properties. [1] [2] [3]Certs/Properties/PoV.lagda.md,Certs/Properties/PoVLemmas.lagda.md,Certs/Properties/VoteDelegsVDeleg.lagda.md, and similar files for chain and epoch properties. Each file contains a dedicated section with an explicit anchor for the property or theorem. [1] [2] [3] [4] [5] [6] [7] [8]Content Improvements:
Cross-Referencing and Navigation:
links.mdby adding direct links to theorems and claims, using section anchors for each property, and updating references to point to the new documentation structure. [1] [2] [3]Properties.mdentry and ensuring each property is accessible via its own page.Minor Codebase Improvements:
HasGovStateinEpochState, ensuring consistency in the Agda specification.These changes make the formal ledger specification more modular, navigable, and maintainable, with each property clearly documented and easily referenced.
Checklist
CHANGELOG.md