Skip to content

Phase 1: Relocate design documents and fix naming #3

Description

@tinkermonkey

Move all existing design documents into a documentation/ directory, update cross-references, and replace all remaining 'chronicle' references with the canonical 'context-library' / context_library identifiers.

Requirements

  • Create documentation/ directory at project root
  • Move Architecture.mddocumentation/Architecture.md
  • Move persistence-design.mddocumentation/persistence-design.md
  • Move chunking-strategy.mddocumentation/chunking-strategy.md
  • Update README.md to reference all three documents at their new documentation/ paths (the existing README contains a broken link ./ARCHITECTURE.md that must be corrected to ./documentation/Architecture.md)
  • Replace every occurrence of 'chronicle' / 'Chronicle' in persistence-design.md:
    • 'How Chronicle stores' → 'How Context Library stores'
    • 'Chronicle uses' → 'Context Library uses'
    • ~/.chronicle/~/.context-library/
    • chronicle.dbcontext_library.db
    • "project-chronicle""project-context-library"
    • "project": "chronicle""project": "context-library"
  • Verify no file in the repository contains the string 'chronicle' after this phase

Design Guidance

  • No Python code is introduced in this phase
  • All internal links in the three design documents that point to each other must remain valid after relocation; since all three files move into the same directory, relative links between them (if any) require no change, but any absolute or root-relative paths must be updated
  • The README currently links to design docs at the root level; all such links must be rewritten to use the documentation/ prefix
  • Use git mv for each file so history is preserved

Acceptance Criteria

  • documentation/Architecture.md, documentation/persistence-design.md, and documentation/chunking-strategy.md all exist
  • The original files no longer exist at the project root
  • Running grep -r 'chronicle' . (excluding .git/) returns no matches
  • Every link in README.md that points to a design document resolves to a path under documentation/
  • All cross-reference links within the three documentation files resolve correctly

Parent Issue

Part of #1

Discussion

This work is detailed in discussion 2

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions