Skip to content
  • Thomas Tran's avatar
    Docs/enhance docs (#24) · b58dbfd1
    Thomas Tran authored
    
    
    * docs: update docs
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    * fix: cicd
    
    Fix workflow issues
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    * docs: Rename 'articles' to 'use-cases' and update docs
    
    Replace the docs/articles section with a new docs/use-cases area and update references across the docs. AGENTS.md and docs/README.md were updated to point to docs/use-cases/; docs/articles/README.md was removed and docs/use-cases/README.md was added. Several article files were moved into use-cases (automated-compliance, crossborder, financial-ai, incident-response, quantum-key-distribution, retail-ecommerce-returns, telco-esim).
    
    Large refactors to conceptual docs: architecture.md was rewritten and reorganized into a concise Architecture Guide (system overview, package selection, deployment patterns, security checklist, examples and code snippets), haip-compliance.md was turned into a HAIP Integration Guide with validators, middleware and code examples, and haip-deep-dive.md was expanded with glossary, levels, examples and testing guidance. These changes restructure content, refresh examples, and align documentation with the new use-cases taxonomy.
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    * docs: Add tutorials, samples and benchmark updates
    
    Add a full tutorials section and 19 hands-on sample tutorials (beginner → advanced) under docs/tutorials and samples/SdJwt.Net.Samples; remove legacy core/HAIP/real-world sample files. Enhance benchmarks: add richer Core/StatusList/HAIP benchmark scenarios, descriptions and targets, include additional project references in benchmarks csproj, and expand benchmark README. Update repository README (badge, stats, wording) and docs links (HAIP sample → tutorial). Small VS Code settings tweak to allow New-Item in chat tool approvals.
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    * test: Improve CI workflows and add tests/docs
    
    Enable draft releases in release-please config and reformat changelog entries. Refactor and standardize CI workflows (.github/workflows/*): normalize quoting/indentation, consolidate and reorder steps, unify .NET setup and caching, add markdown formatting and documentation-coverage checks, strengthen package/ecosystem validation, streamline integration scenarios, preserve codecov/benchmark uploads, and document that NuGet publishing is handled by a separate workflow. Simplify the reusable build pack to run on ubuntu, centralize packing/validation and artifact uploads, and add additional security/HAIP validation steps. Also add project documentation and numerous unit test files under tests/ to improve coverage and validations.
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    * docs: Normalize docs tables and clean up whitespace
    
    Reformat Markdown tables and align columns across many documentation and README files for consistent appearance (AGENTS.md, CONTRIBUTING.md, MAINTAINERS.md, SETUP_HOOKS.md, benchmarks/README.md, docs/*, specs/*, samples/*, src/* README files, reports/*). Also perform minor whitespace and formatting cleanup in HAIP-related code and tests. These are non-functional formatting changes to improve readability and consistency.
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    
    ---------
    
    Signed-off-by: default avatarThomas Tran <tldinteractive@gmail.com>
    b58dbfd1
Loading