Repository navigation
Move github wiki into repo + add styleguides - #73
Merged
Merged
Conversation
styleguide/ holds one file per language plus an index; AGENTS.md routes agents to the file for what they are editing instead of inlining the rules, so only the relevant part is loaded. The conventions are derived from the existing code. A .clang-format matching the current C++ is added; existing files are formatted line by line as they are touched. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
The GitHub wiki is not versioned with the code and had drifted from it. Its pages move into devdocs/design/ (workflow, data model, package structure) next to the style guide, under one devdocs/ index that also carries the Diataxis "what goes where" overview. Updated against the current code while migrating: DuckLake instead of a DuckDB file, trans_pot_t carries id_run, alloc_params_t gains patch_elongation, periods_t derived columns and inclusive end dates. The package-structure page is rewritten for ducklake_db/evoland_db; its workflow walkthrough is left to the getting-started vignette. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
mmyrte
changed the title
devdocs/er_diagram.R derives the Mermaid ER diagram from the empty tables the exported as_*_t() constructors return: columns, types, key, alternate key and map columns from their attributes, foreign keys from the id_<entity> naming convention. The er-diagram workflow regenerates it and fails when devdocs/design/database.md differs. Refs #71 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
… loop Refs #71 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
Refs #71 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
mmyrte
commented
Oct 19, 2026
This was referenced Oct 19, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
Pipes over single-use intermediate names, index logic on one side of the R/C++ boundary, @describeIn as legacy, no rhetorical contrasts in prose. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
runs_t listed trans_rates_t's columns, trans_pot_t lacked id_run and described value as a parameter map, lulc_meta_t lacked src_classes, and trans_rates_t called rates probabilities. Also syncs man/ pages that were stale on develop. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
Refs #68 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
Reuses the dependency setup rather than paying for it twice per PR. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F64irZbJjZgMc24W7wZimL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The github wiki was out of date anyways, plus it's good for humans and machines alike to have access to a folder with documentation rationale.
This PR also includes styleguides, because the code style is currently a little inconsistent. This provides a first shot at
Note that the styleguides are not descriptive of the current state, but rather prescriptive of changes to come