docs: Add ProjectDiary.md for tracking development milestones
- Create ProjectDiary.md with reverse chronological milestone tracking - Add make add-diary-entry target with Claude Code prerequisite check - Include initial entry documenting today's infrastructure setup - Track contributors, time estimates, and AI token usage - Provide structured format for future development logging - Guide users through diary entry creation process 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
33
Makefile
33
Makefile
@@ -1,7 +1,7 @@
|
||||
# MarkiTect - Advanced Markdown Engine
|
||||
# Makefile for common development tasks
|
||||
|
||||
.PHONY: help setup install test build clean update status dev lint format check-deps venv-status update-digest
|
||||
.PHONY: help setup install test build clean update status dev lint format check-deps venv-status update-digest add-diary-entry
|
||||
|
||||
# Default target
|
||||
help:
|
||||
@@ -30,7 +30,8 @@ help:
|
||||
@echo " check-deps - Check dependency status"
|
||||
@echo ""
|
||||
@echo "Documentation:"
|
||||
@echo " update-digest - Update ProjectStatusDigest.md (requires Claude Code)"
|
||||
@echo " update-digest - Update ProjectStatusDigest.md (requires Claude Code)"
|
||||
@echo " add-diary-entry - Add new entry to ProjectDiary.md (requires Claude Code)"
|
||||
|
||||
# Python and virtual environment setup
|
||||
PYTHON := python3
|
||||
@@ -174,3 +175,31 @@ update-digest:
|
||||
@echo " Command: 'Please update ProjectStatusDigest.md with the current project state'"
|
||||
@echo ""
|
||||
@echo "💡 Tip: You can also manually edit ProjectStatusDigest.md if needed"
|
||||
|
||||
# Add new entry to project diary (requires Claude Code)
|
||||
add-diary-entry:
|
||||
@echo "🔍 Checking for Claude Code availability..."
|
||||
@if ! command -v claude >/dev/null 2>&1; then \
|
||||
echo "❌ Claude Code not found in PATH"; \
|
||||
echo " This target requires Claude Code CLI to be installed"; \
|
||||
echo " Visit: https://claude.ai/code for installation instructions"; \
|
||||
exit 1; \
|
||||
fi
|
||||
@echo "✅ Claude Code found"
|
||||
@if [ ! -f ProjectDiary.md ]; then \
|
||||
echo "❌ ProjectDiary.md not found"; \
|
||||
echo " Create the diary file first or run this from the project root"; \
|
||||
exit 1; \
|
||||
fi
|
||||
@echo "📖 Adding new entry to ProjectDiary.md..."
|
||||
@echo " Please ask Claude Code to add a new diary entry for recent work"
|
||||
@echo " Command: 'Please add a new entry to ProjectDiary.md summarizing recent progress'"
|
||||
@echo ""
|
||||
@echo "📋 Entry should include:"
|
||||
@echo " - Date ($(shell date +%Y-%m-%d))"
|
||||
@echo " - One-line progress characterization"
|
||||
@echo " - Contributors since last entry"
|
||||
@echo " - Time estimate and AI token usage"
|
||||
@echo " - One paragraph work summary"
|
||||
@echo ""
|
||||
@echo "💡 Tip: New entries are added to the top for reverse chronological order"
|
||||
|
||||
Reference in New Issue
Block a user