docs: add repository organization notes#1
Open
theChristopher16 wants to merge 1 commit into
Open
Conversation
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
2 participants
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.
Adds preservation-first repository organization docs:
docs/CODEMAP.mdwith current structure and code areasdocs/REPOSITORY_STATUS.mdwith preservation status and Obsidian/index linksNo code is deleted or moved in this PR.
Note
Low Risk
Low risk: documentation-only changes that add repository metadata and preservation guidelines without touching source code or runtime behavior.
Overview
Adds a repository-organization section to
README.mdlinking to a newdocs/CODEMAP.mdanddocs/REPOSITORY_STATUS.md.The new docs capture the repo’s cataloging metadata (classification/activity), top-level structure, external index/Obsidian references, and a non-destructive preservation rule to avoid deleting historical code.
Reviewed by Cursor Bugbot for commit fa86a15. Bugbot is set up for automated code reviews on this repo. Configure here.