Skip to content

chore: clean up project root#45

Merged
ashu17706 merged 5 commits intodevfrom
docs/improvements
Mar 2, 2026
Merged

chore: clean up project root#45
ashu17706 merged 5 commits intodevfrom
docs/improvements

Conversation

@ashu17706
Copy link
Contributor

@ashu17706 ashu17706 commented Mar 2, 2026

Summary

The project root had accumulated a lot of docs that didn't belong there. This PR cleans it up.

Moved to docs/internal/ (renamed to kebab-case):

  • IMPLEMENTATION.mdimplementation.md
  • IMPLEMENTATION_CHECKLIST.mdimplementation-checklist.md
  • PHASE1_IMPLEMENTATION.mdphase1-implementation.md
  • INGEST_ARCHITECTURE.mdingest-architecture.md
  • DEMO_RESULTS.mddemo-results.md
  • RULES_QUICK_REFERENCE.mdrules-quick-reference.md
  • QUICKSTART.mdsegmentation-quickstart.md
  • majestic-sauteeing-papert.mdqmd-deep-dive.md
  • streamed-humming-curry.mdingest-refactoring.md

Deleted:

  • issues.json — GitHub issues export, not source or docs
  • zsh-autosuggestions/, zsh-syntax-highlighting/ — personal zsh plugins, unrelated to the project

Updated: references to INGEST_ARCHITECTURE.md in README.md and CLAUDE.md.

Project root now contains only what belongs: README.md, LICENSE, CHANGELOG.md, CLAUDE.md, package.json, install/uninstall scripts, and source directories.

Test plan

  • Verify no broken links in README.md and CLAUDE.md
  • Confirm root directory looks clean

Baseline User and others added 5 commits March 2, 2026 12:56
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Rewrite README with vision-first framing — leads with the agentic
  memory problem, origin story, and Ingest→Categorize→Recall→Search
  as the central concept
- Add docs/cli.md as the complete command reference (moved out of README)
- Add docs/search.md as a user-facing guide to search vs recall
- Rewrite all user-facing docs (getting-started, team-sharing,
  configuration, architecture) to match README tone — direct, honest,
  opens with context before diving into mechanics
- Reorganize docs structure: kebab-case throughout, internal planning
  docs move to docs/internal/, personal writing gitignored via
  docs/writing/
- Rename: CI_HARDENING_EXECUTION_PLAN → internal/ci-hardening,
  DESIGN → internal/design, WORKFLOW_AUTOMATION → internal/workflow-automation,
  e2e-dev-release-flow-test → internal/e2e-release-flow,
  search-recall-architecture → internal/search-analysis
- Update .gitignore: add docs/writing/, .letta/, zsh plugins

👾 Generated with [Letta Code](https://letta.com)

Co-Authored-By: Letta <noreply@letta.com>
…utter

Move 9 root-level docs to docs/internal/ with kebab-case rename:
  IMPLEMENTATION.md             → docs/internal/implementation.md
  IMPLEMENTATION_CHECKLIST.md   → docs/internal/implementation-checklist.md
  PHASE1_IMPLEMENTATION.md      → docs/internal/phase1-implementation.md
  INGEST_ARCHITECTURE.md        → docs/internal/ingest-architecture.md
  DEMO_RESULTS.md               → docs/internal/demo-results.md
  RULES_QUICK_REFERENCE.md      → docs/internal/rules-quick-reference.md
  QUICKSTART.md                 → docs/internal/segmentation-quickstart.md
  majestic-sauteeing-papert.md  → docs/internal/qmd-deep-dive.md
  streamed-humming-curry.md     → docs/internal/ingest-refactoring.md

Remove:
  issues.json — GitHub issues export, not source or documentation
  zsh-autosuggestions/, zsh-syntax-highlighting/ — personal zsh plugins,
    unrelated to the project (already gitignored)

Update references to INGEST_ARCHITECTURE.md in README.md and CLAUDE.md.

Project root now contains only what belongs there: README, LICENSE,
CHANGELOG, CLAUDE.md, package.json, install/uninstall scripts, and
source directories.
Adds a Memory section at the top of CLAUDE.md that instructs Claude Code
to use Smriti actively — not passively. Modeled on the Loop pattern:
action-first, not acknowledgment-first.

- Recall at session start before writing code
- Recognize decision/finalization moments and act immediately
- Concrete wrong/right example with actual bash commands
- Category guide for correct tagging
- No asking permission — just save it
@ashu17706 ashu17706 merged commit 8226f62 into dev Mar 2, 2026
7 checks passed
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.

1 participant