docs: migrate all documentation to single 'notes' mode, update CLI usage and structure

Author: sijanthapa171

Docs/DevelopmentGuide/DETAILED_IMPLEMENTATION.md

@@ -123,18 +123,14 @@ graph TD
 ```mermaid
 graph TD
     Root[/Data Directory/] --> Notes[/Notes/]
-    Root --> Recipes[/Recipes/]
     Root --> Versions[/Versions/]
     Root --> Logs[/Logs/]
     
     Notes --> N1[note1.txt]
     Notes --> N2[note2.txt]
     
-    Recipes --> R1[recipe1.txt]
-    Recipes --> R2[recipe2.txt]
-    
     Versions --> V1[note1_20240315_123456.txt]
-    Versions --> V2[recipe1_20240315_123456.txt]
+    Versions --> V2[note1_20240315_123456.txt]
     
     Logs --> L1[history.txt]
     Logs --> L2[error.log]
@@ -482,13 +478,12 @@ graph TD
 command_args_t parse_arguments(int argc, char *argv[]) {
     command_args_t args = {
         .cmd_type = CMD_INVALID,
-        .category = NULL,
         .filename = NULL,
         .valid = false
     };
 
     // Validate argument count
-    if (argc < 4) {
+    if (argc < 3) {
         return args;
     }
 
@@ -499,8 +494,7 @@ command_args_t parse_arguments(int argc, char *argv[]) {
         args.cmd_type = CMD_READ;
     } // ... other commands
 
-    args.category = argv[2];
-    args.filename = argv[3];
+    args.filename = argv[2];
     args.valid = true;
     return args;
 }
@@ -530,9 +524,9 @@ bool validate_command(command_args_t *args) {
 
 #### File Creation Example
 ```c
-bool create_document(const char *category, const char *filename) {
+bool create_document(const char *filename) {
     char filepath[MAX_PATH_LENGTH];
-    snprintf(filepath, MAX_PATH_LENGTH, "data/%s/%s", category, filename);
+    snprintf(filepath, MAX_PATH_LENGTH, "data/%s", filename);
 
     // Check if file exists
     if (file_exists(filepath)) {
@@ -560,16 +554,16 @@ bool create_document(const char *category, const char *filename) {
 
 #### File Update with Version Control
 ```c
-bool update_document(const char *category, const char *filename) {
+bool update_document(const char *filename) {
     // Create backup before update
-    if (!create_version_backup(category, filename)) {
+    if (!create_version_backup(filename)) {
         log_error("Failed to create backup");
         return false;
     }
 
     // Perform update
     char filepath[MAX_PATH_LENGTH];
-    snprintf(filepath, MAX_PATH_LENGTH, "data/%s/%s", category, filename);
+    snprintf(filepath, MAX_PATH_LENGTH, "data/%s", filename);
     
     FILE *fp = fopen(filepath, "w");
     if (!fp) {
@@ -846,18 +840,17 @@ typedef struct {
 ```c
 void test_create_document(void) {
     // Setup
-    const char *category = "test";
     const char *filename = "test_doc.txt";
 
     // Test
-    bool result = create_document(category, filename);
+    bool result = create_document(filename);
 
     // Assert
     assert(result == true);
-    assert(file_exists("data/test/test_doc.txt"));
+    assert(file_exists("data/test_doc.txt"));
 
     // Verify content
-    char *content = read_document(category, filename);
+    char *content = read_document(filename);
     assert(content != NULL);
     assert(strcmp(content, "test content") == 0);
 

Docs/DevelopmentGuide/README.md

@@ -109,7 +109,6 @@ graph TD
     Include --> UtilsH[utils.h]
     
     Data --> Notes[notes/]
-    Data --> Recipes[recipes/]
     Data --> Versions[versions/]
     Data --> Logs[logs/]
     
@@ -133,7 +132,7 @@ graph TD
    mkdir -p src include data bin obj tests
 
    # Create data subdirectories
-   mkdir -p data/{notes,recipes,versions,logs}
+   mkdir -p data/{notes,versions,logs}
    ```
 
 3. **Create Initial Files**
@@ -200,8 +199,7 @@ typedef enum {
 // Command arguments structure
 typedef struct {
     command_type_t cmd_type;
-    char *category;
-    char *filename;
+    char filename[256];
     bool valid;
 } command_args_t;
 
@@ -221,10 +219,10 @@ b. **file_ops.h** - File Operations
 #include <stdbool.h>
 
 // File operation functions
-bool create_document(const char *category, const char *filename);
-bool read_document(const char *category, const char *filename);
-bool update_document(const char *category, const char *filename);
-bool delete_document(const char *category, const char *filename);
+bool create_document(const char *filename);
+bool read_document(const char *filename);
+bool update_document(const char *filename);
+bool delete_document(const char *filename);
 
 #endif // FILE_OPS_H
 ```

Docs/design_rationale.md

@@ -33,7 +33,6 @@ src/
 ```c
 typedef struct {
     command_type_t cmd_type;
-    char category[64];
     char filename[256];
     bool valid;
 } command_args_t;
@@ -54,10 +53,9 @@ typedef struct {
 
 ```
 data/
-├── recipes/   # Category-based organization
-├── notes/
-├── logs/      # Operation history
-└── versions/  # Backup storage
+├── notes/      # Note documents
+├── logs/       # Operation history
+└── versions/   # Backup storage
 ```
 
 **Advantages:**
@@ -155,8 +153,8 @@ Input → Validation → Operation → Logging → Result
 ```c
 // On update, before modifying file:
 snprintf(version_path, sizeof(version_path), 
-         "%s/%s_%s_%s", 
-         VERSIONS_DIR, category, timestamp, filename);
+         "%s/notes_%s_%s", 
+         VERSIONS_DIR, timestamp, filename);
 ```
 
 **Benefits:**

documentation.md

@@ -38,7 +38,7 @@ HOD Signature: [HOD Name]
 Department Seal
 
 ## Abstract
-NoteCLI is a command-line based notepad application written in C that provides users with a robust and efficient way to manage text documents. The system implements CRUD (Create, Read, Update, Delete) operations with additional features like automatic versioning and comprehensive operation logging. The application emphasizes data organization through categories, ensuring systematic document management while maintaining version history and operation tracking.
+NoteCLI is a command-line based notepad application written in C that provides users with a robust and efficient way to manage text documents. The system implements CRUD (Create, Read, Update, Delete) operations with additional features like automatic versioning and comprehensive operation logging. The application emphasizes data organization through a dedicated notes directory, ensuring systematic document management while maintaining version history and operation tracking.
 
 ## Table of Contents
 1. [Introduction](#introduction)
@@ -58,7 +58,7 @@ NoteCLI is a command-line based notepad application written in C that provides u
 
 ## 1. Introduction
 NoteCLI is a modern solution for text document management through command-line interface. The application provides a seamless experience for users who prefer terminal-based operations, offering robust features like:
-- Category-based document organization
+- Dedicated notes directory for document organization
 - Automatic version control
 - Comprehensive operation logging
 - Error handling and validation
@@ -77,7 +77,7 @@ NoteCLI addresses these limitations by providing a structured approach to docume
 ## 3. Objectives
 1. Develop a command-line based notepad application
 2. Implement CRUD operations for text documents
-3. Create a category-based file organization system
+3. Organize all documents in a single notes directory
 4. Integrate automatic version control
 5. Implement comprehensive operation logging
 6. Ensure robust error handling and validation
@@ -260,14 +260,13 @@ graph TD
 ```
 NoteCLI/
 ├── bin/               # Compiled binary
-├── src/              # Source code files
-├── include/          # Header files
-├── data/             # Document storage
-│   ├── recipes/      # Recipe documents
-│   ├── notes/        # Note documents
-│   ├── logs/         # Operation logs
-│   └── versions/     # Version backups
-└── obj/              # Object files
+├── src/               # Source code files
+├── include/           # Header files
+├── data/              # Document storage
+│   ├── notes/         # Note documents
+│   ├── logs/          # Operation logs
+│   └── versions/      # Version backups
+└── obj/               # Object files
 ```
 
 #### Operation Procedure
@@ -279,17 +278,17 @@ make         # Build new executable
 
 2. Running Commands
 ```bash
-# Create document
-./bin/NotesCLI create <category> <filename>
+# Create note
+./bin/NotesCLI create <filename>
 
-# Read document
-./bin/NotesCLI read <category> <filename>
+# Read note
+./bin/NotesCLI read <filename>
 
-# Update document
-./bin/NotesCLI update <category> <filename>
+# Update note
+./bin/NotesCLI update <filename>
 
-# Delete document
-./bin/NotesCLI delete <category> <filename>
+# Delete note
+./bin/NotesCLI delete <filename>
 ```
 
 ## 9. Testing
@@ -347,24 +346,24 @@ make clean && make
 
 2. Create a note:
 ```bash
-./bin/NotesCLI create notes todo.txt
+./bin/NotesCLI create todo.txt
 # Enter content and press Ctrl+D
 ```
 
 3. Read the note:
 ```bash
-./bin/NotesCLI read notes todo.txt
+./bin/NotesCLI read todo.txt
 ```
 
 4. Update the note:
 ```bash
-./bin/NotesCLI update notes todo.txt
+./bin/NotesCLI update todo.txt
 # Enter new content and press Ctrl+D
 ```
 
 5. Delete the note:
 ```bash
-./bin/NotesCLI delete notes todo.txt
+./bin/NotesCLI delete todo.txt
 ```
 
 ## 11. Future Enhancements
@@ -406,18 +405,13 @@ The NoteCLI project demonstrates the effectiveness of command-line based documen
 ## 14. Annex
 ### A. Command Reference
 ```bash
-NotesCLI <command> <category> <filename>
+NotesCLI <command> <filename>
 
 Commands:
-  create  - Create a new document
-  read    - Read an existing document
-  update  - Update an existing document
-  delete  - Delete an existing document
-
-Categories:
-  recipes - For storing recipes
-  notes   - For general notes
-  logs    - For logs and records
+  create  - Create a new note
+  read    - Read an existing note
+  update  - Update an existing note
+  delete  - Delete an existing note
 ```
 
 ### B. Error Codes