tractatus/scripts/update-document-metadata.js
TheFlow 2fc6e0a593 feat: implement documentation reorganization with archives
Documentation Reorganization (Option A - Full):
- Reduced public docs from 47 to 11 (76% reduction)
- 31 documents archived (project tracking, outdated)
- 5 documents marked confidential (security, payments)
- Clear 3-tier structure: Getting Started, Framework Details, Case Studies

Archives Infrastructure:
- Added visibility: 'archived' | 'public' | 'confidential' | 'internal'
- Added category: 'conceptual' | 'practical' | 'reference' | 'archived' | 'project-tracking'
- Added order field for explicit document ordering (1-11 for public)
- Added archiveNote field for explaining why documents were archived
- New endpoint: GET /api/documents/archived
- New controller method: listArchivedDocuments()
- UI: Archives section (collapsed by default) at bottom of docs list

Public Documentation (11 documents, well-organized):
  1. Architectural Overview (reference)
  2. Core Concepts (conceptual) - needs Phase 5 update
  3. Implementation Guide (practical) - needs MongoDB rewrite
  4. Core Values & Principles (conceptual)
  5. Case Studies (practical)
  6. Business Case Template (practical)
  7. Glossary (reference) - needs Phase 5 terms
  8-11. Recent Case Studies (practical)

Model Updates:
- src/models/Document.model.js: Added visibility, category, order, archiveNote fields
- src/models/Document.model.js: Added listArchived() static method
- Default sort by order (1-999) instead of date

Controller Updates:
- src/controllers/documents.controller.js: Added listArchivedDocuments()
- Filter excludes archived docs from main list by default

Route Updates:
- src/routes/documents.routes.js: Added GET /api/documents/archived

UI Updates:
- public/js/docs-app.js: New category structure (Getting Started, Framework Details, Reference)
- public/js/docs-app.js: Fetches and displays archived documents in collapsed section
- public/js/docs-app.js: Archives show document count badge
- public/js/docs-app.js: Archive notes displayed below archived document links
- Auto-loads Architectural Overview (order: 1) on page load

Scripts Created:
- scripts/archive-outdated-documents.js: Archive 10 outdated documents
- scripts/update-document-metadata.js: Set order/category for 7 core docs
- scripts/archive-all-internal-documents.js: Mass archive 23 internal docs

Documentation:
- docs/DOCUMENT_AUDIT_2025-10-11.md: Comprehensive audit of all 47 documents
- docs/DOCUMENT_REORGANIZATION_SUMMARY.md: Executive summary with before/after

Next Steps (Phase 2 - Content Updates):
- Update Core Concepts for Phase 5 MongoDB architecture
- Rewrite Implementation Guide for MongoDB deployment
- Update Glossary with Phase 5 terms (MongoDB, MemoryProxy, API Memory)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-11 01:26:14 +13:00

149 lines
3.8 KiB
JavaScript

/**
* Update Document Metadata and Ordering
* Sets proper order, category, and audience for public documents
*/
const { MongoClient } = require('mongodb');
// MongoDB connection
const MONGODB_URI = process.env.MONGODB_URI || 'mongodb://localhost:27017/tractatus_dev';
const DB_NAME = process.env.MONGODB_DB || 'tractatus_dev';
// Document metadata updates
const DOCUMENT_UPDATES = [
// GETTING STARTED (order: 1-3)
{
slug: 'architectural-overview-and-research-status',
order: 1,
category: 'reference',
audience: 'general',
visibility: 'public'
},
{
slug: 'core-concepts-of-the-tractatus-framework',
order: 2,
category: 'conceptual',
audience: 'general',
visibility: 'public'
},
{
slug: 'implementation-guide',
order: 3,
category: 'practical',
audience: 'technical',
visibility: 'public'
},
// FRAMEWORK DETAILS (order: 4-6)
{
slug: 'tractatus-ai-safety-framework-core-values-and-principles',
order: 4,
category: 'conceptual',
audience: 'general',
visibility: 'public'
},
{
slug: 'case-studies-real-world-llm-failure-modes',
order: 5,
category: 'practical',
audience: 'general',
visibility: 'public'
},
{
slug: 'ai-governance-business-case-template-tractatus-framework',
order: 6,
category: 'practical',
audience: 'business',
visibility: 'public'
},
// REFERENCE (order: 7)
{
slug: 'tractatus-agentic-governance-system-glossary-of-terms',
order: 7,
category: 'reference',
audience: 'general',
visibility: 'public'
}
];
async function main() {
console.log('=== Updating Document Metadata ===\n');
let client;
try {
// Connect to MongoDB
console.log('Connecting to MongoDB...');
client = await MongoClient.connect(MONGODB_URI);
const db = client.db(DB_NAME);
const collection = db.collection('documents');
console.log('✓ Connected\n');
let updated = 0;
let notFound = 0;
// Update each document
for (const doc of DOCUMENT_UPDATES) {
console.log(`Updating: ${doc.slug}`);
console.log(` Order: ${doc.order} | Category: ${doc.category} | Audience: ${doc.audience}`);
const result = await collection.updateOne(
{ slug: doc.slug },
{
$set: {
order: doc.order,
category: doc.category,
audience: doc.audience,
visibility: doc.visibility
}
}
);
if (result.matchedCount > 0) {
console.log(` ✓ Updated\n`);
updated++;
} else {
console.log(` ⚠ Not found in database\n`);
notFound++;
}
}
// Summary
console.log('=== Summary ===\n');
console.log(`✓ Updated: ${updated} documents`);
if (notFound > 0) {
console.log(`⚠ Not found: ${notFound} documents`);
}
console.log(`\nTotal processed: ${DOCUMENT_UPDATES.length}`);
// Verify organization
console.log('\n=== Verification ===\n');
const publicDocs = await collection.find({ visibility: 'public' })
.sort({ order: 1 })
.project({ title: 1, order: 1, category: 1, audience: 1 })
.toArray();
console.log('Public documents (sorted by order):');
publicDocs.forEach(doc => {
console.log(` ${doc.order}. ${doc.title}`);
console.log(` Category: ${doc.category} | Audience: ${doc.audience}\n`);
});
const archivedCount = await collection.countDocuments({ visibility: 'archived' });
console.log(`\n📦 Archived: ${archivedCount} documents`);
console.log(`📖 Public: ${publicDocs.length} documents`);
} catch (error) {
console.error('\n✗ Error:', error.message);
console.error(error.stack);
process.exit(1);
} finally {
if (client) await client.close();
}
}
// Run if called directly
if (require.main === module) {
main();
}
module.exports = { main };