Skip to content

docs: add repository organization notes#1

Open
theChristopher16 wants to merge 1 commit intomasterfrom
repo-organization-2026-05-05
Open

docs: add repository organization notes#1
theChristopher16 wants to merge 1 commit intomasterfrom
repo-organization-2026-05-05

Conversation

@theChristopher16
Copy link
Copy Markdown
Owner

@theChristopher16 theChristopher16 commented May 5, 2026

Adds preservation-first repository organization docs:

  • docs/CODEMAP.md with current structure and code areas
  • docs/REPOSITORY_STATUS.md with preservation status and Obsidian/index links
  • README organization section or README bootstrap where missing

No code is deleted or moved in this PR.


Note

Low Risk
Documentation-only changes that add repository status/organization notes; no code paths, build behavior, or runtime logic are affected.

Overview
Adds a repository organization section to README.md linking to a new docs/CODEMAP.md and docs/REPOSITORY_STATUS.md.

Introduces preservation/cleanup guidance, classification (legacy/cold), and external index/Obsidian references, with an explicit non-destructive rule to avoid deleting historical code.

Reviewed by Cursor Bugbot for commit 489ec04. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 489ec04. Configure here.

Comment thread docs/REPOSITORY_STATUS.md

- Central index: <https://github.com/theChristopher16/github-repository-index>
- Obsidian catalog: `OpenClaw Wiki/GitHub/GitHub Repository Organization Catalog.md`
- Local preservation archive root: `/home/christophersmith/.openclaw/repo-archive/github/theChristopher16/2026-05-05`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Local filesystem path exposes personal information publicly

Medium Severity

The Local preservation archive root field in docs/REPOSITORY_STATUS.md includes an absolute local filesystem path. This exposes a personal username and internal directory structure, which is publicly visible in this public repository and not relevant to external readers.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 489ec04. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants