SecureArc Documentation

Welcome to the SecureArc documentation! This directory contains comprehensive documentation for users, developers, and contributors.

Documentation Index

For Users

User Guide - Complete end-user documentation covering GUI and CLI usage, best practices, and troubleshooting
Installation Guide - Step-by-step installation instructions for all platforms
CLI Reference - Complete command-line interface documentation with examples

For Developers

API Reference - Library API documentation for integrating SecureArc into applications
Format Specification - Technical specification of the SecureArc file format
Security Model - Security analysis, threat model, and cryptographic details
Testing Guide - Testing instructions and examples for developers

Quick Links

Getting Started: Start with the Installation Guide, then read the User Guide
Command Line: See CLI Reference for all available commands
Integration: Check API Reference for library usage
Security: Review Security Model for security considerations

Documentation Structure

docs/
├── README.md              # This file - documentation index
├── USER_GUIDE.md          # End-user documentation
├── INSTALLATION.md        # Installation instructions
├── CLI_REFERENCE.md       # CLI command reference
├── api-reference.md       # Library API documentation
├── format-spec.md         # File format specification
├── security-model.md      # Security analysis
└── testing-guide.md       # Testing guide

Contributing to Documentation

When updating documentation:

Keep examples up-to-date with the latest code
Test all code examples before committing
Use proper Markdown formatting for GitHub
Add cross-references between related documents
Update this index if adding new documentation files

Questions?

If you have questions or find issues with the documentation:

Check the relevant guide above
Review the User Guide for common questions
Check the Security Model for security-related questions
Open an issue on GitHub for documentation improvements

2.4 KiB Raw Permalink Blame History