docs: Major documentation cleanup and accuracy fixes for 1.0
✨ RESTORED the 9th method - augment() for infinite extensibility! REMOVED (20 files): - All business strategy and revenue projection documents - Misleading Cortex CLI documentation - Outdated duplicate documentation - Internal technical analysis files FIXED: - ✅ Corrected to 9 unified methods (was incorrectly showing 8) - ✅ The 9th method `augment()` enables methods 10→∞ - ✅ Removed non-existent CLI commands (add-noun, add-verb) - ✅ Brain Cloud marked as "Early Access" with real pricing - ✅ Aligned with actual soulcraft.com offerings - ✅ All code examples now match actual implementation CONSOLIDATED: - Combined 3 augmentation docs into single AUGMENTATIONS.md - Removed duplicate quick-start guides ADDED: - cleanup-git-history.sh script for removing sensitive files from history - Clear Brain Cloud pricing tiers ($19 Cloud Sync, $99 Enterprise) - Transparency about optional services sustaining development All documentation is now accurate, honest, and appropriate for an MIT open source project with optional cloud services.
This commit is contained in:
parent
032cb872b9
commit
4fdaa7e22c
20 changed files with 364 additions and 4801 deletions
60
cleanup-git-history.sh
Executable file
60
cleanup-git-history.sh
Executable file
|
|
@ -0,0 +1,60 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Script to remove sensitive business strategy files from git history
|
||||
# WARNING: This rewrites git history! Make sure to backup first.
|
||||
|
||||
echo "⚠️ WARNING: This will rewrite git history!"
|
||||
echo "Make sure you have a backup and all team members are aware."
|
||||
echo ""
|
||||
read -p "Continue? (y/N): " -n 1 -r
|
||||
echo ""
|
||||
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
echo "Aborted."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Removing sensitive files from git history..."
|
||||
|
||||
# Files to remove from history
|
||||
FILES_TO_REMOVE=(
|
||||
"IMPLEMENTATION-ROADMAP.md"
|
||||
"CORTEX.md"
|
||||
"CORTEX-ROADMAP.md"
|
||||
"docs/STRATEGIC-IMPLEMENTATION-PLAN.md"
|
||||
"ACTUAL_CONFIG_STRATEGY.md"
|
||||
"MODEL_STRATEGY.md"
|
||||
"METADATA_OPTIMIZATION_PROPOSAL.md"
|
||||
"METADATA_PERFORMANCE_ANALYSIS.md"
|
||||
"PERFORMANCE_OPTIMIZATION_TODO.md"
|
||||
"TENSORFLOW_TO_TRANSFORMERS_ANALYSIS.md"
|
||||
"MIGRATION_PLAN_DEPRECATED_METHODS.md"
|
||||
"AUGMENTATION_ARCHITECTURE.md" # Contains pricing info
|
||||
"CLI_AUGMENTATION_GUIDE.md"
|
||||
"docs/brainy-cli.md"
|
||||
"docs/getting-started/quick-start.md"
|
||||
"docs/distributed-deployment-scenario.md"
|
||||
"docs/distributed-usage-guide.md"
|
||||
"docs/brainy-distributed-enhancements.md"
|
||||
"docs/brainy-distributed-enhancements-revised.md"
|
||||
)
|
||||
|
||||
# Build the filter-branch command
|
||||
for file in "${FILES_TO_REMOVE[@]}"; do
|
||||
echo "Removing $file from history..."
|
||||
FILTER_BRANCH_SQUELCH_WARNING=1 git filter-branch --force --index-filter \
|
||||
"git rm --cached --ignore-unmatch $file" \
|
||||
--prune-empty --tag-name-filter cat -- --all
|
||||
done
|
||||
|
||||
echo ""
|
||||
echo "✅ Files removed from history."
|
||||
echo ""
|
||||
echo "⚠️ IMPORTANT NEXT STEPS:"
|
||||
echo "1. Force push to remote: git push origin --force --all"
|
||||
echo "2. Force push tags: git push origin --force --tags"
|
||||
echo "3. Tell all team members to re-clone the repository"
|
||||
echo "4. Clean up local repo: git for-each-ref --format='delete %(refname)' refs/original | git update-ref --stdin"
|
||||
echo "5. Run garbage collection: git gc --prune=now --aggressive"
|
||||
echo ""
|
||||
echo "Note: GitHub may still show some cached data for a while."
|
||||
Loading…
Add table
Add a link
Reference in a new issue