From 705639b2f53a8609b0883caa59e83f3ce3d8fda8 Mon Sep 17 00:00:00 2001 From: Daniel Arantes Loverde Date: Sat, 29 Aug 2026 19:22:12 -0300 Subject: [PATCH] [docs] Scaffold reference guides + README Documentation section - Documentation/{Extensions,SwiftUI,UIKit}.md shells with category headings + TOC - README: Documentation table linking all 4 guides - footer: drop the second github badge, keep the resume link --- Documentation/Extensions.md | 52 +++++++++++++++++++++++++++++++++++++ Documentation/SwiftUI.md | 21 +++++++++++++++ Documentation/UIKit.md | 40 ++++++++++++++++++++++++++++ README.md | 13 ++++++++-- 4 files changed, 124 insertions(+), 2 deletions(-) create mode 100644 Documentation/Extensions.md create mode 100644 Documentation/SwiftUI.md create mode 100644 Documentation/UIKit.md diff --git a/Documentation/Extensions.md b/Documentation/Extensions.md new file mode 100644 index 0000000..38b23c5 --- /dev/null +++ b/Documentation/Extensions.md @@ -0,0 +1,52 @@ +# LCEssentials — Extensions + +Foundation, value-type, string, collection, numeric, date, and crypto helpers, plus +the `LCEssentials` namespace itself. UIKit extensions live in +[UIKit.md](UIKit.md); SwiftUI helpers in [SwiftUI.md](SwiftUI.md). + +Every section is a collapsible block — click a heading to expand it. + +## Contents + +- [API & Networking](#api--networking) +- [Strings & Text](#strings--text) +- [Collections & Sequences](#collections--sequences) +- [Numbers & Geometry](#numbers--geometry) +- [Date, Data & Files](#date-data--files) +- [Encoding & Errors](#encoding--errors) +- [Crypto](#crypto) +- [Core — the `LCEssentials` namespace](#core--the-lcessentials-namespace) + +--- + +## API & Networking + + + +## Strings & Text + + + +## Collections & Sequences + + + +## Numbers & Geometry + + + +## Date, Data & Files + + + +## Encoding & Errors + + + +## Crypto + + + +## Core — the `LCEssentials` namespace + + diff --git a/Documentation/SwiftUI.md b/Documentation/SwiftUI.md new file mode 100644 index 0000000..996fe6b --- /dev/null +++ b/Documentation/SwiftUI.md @@ -0,0 +1,21 @@ +# LCEssentials — SwiftUI + +SwiftUI components and `View` helpers. Foundation/value-type helpers are in +[Extensions.md](Extensions.md); UIKit-era helpers in [UIKit.md](UIKit.md). + +Every section is a collapsible block — click a heading to expand it. + +## Contents + +- [Navigation](#navigation) +- [View helpers](#view-helpers) + +--- + +## Navigation + + + +## View helpers + + diff --git a/Documentation/UIKit.md b/Documentation/UIKit.md new file mode 100644 index 0000000..2f8e1e6 --- /dev/null +++ b/Documentation/UIKit.md @@ -0,0 +1,40 @@ +# LCEssentials — UIKit + +UIKit-era helpers: programmatic layout & constraints, view/control extensions, +navigation, table/collection helpers, and drop-in components (image picker, image +zoom, snackbar, GIF loading). + +Foundation/value-type helpers are in [Extensions.md](Extensions.md); SwiftUI +helpers in [SwiftUI.md](SwiftUI.md). + +Every section is a collapsible block — click a heading to expand it. + +## Contents + +- [Layout & Constraints](#layout--constraints) +- [Views & Controls](#views--controls) +- [Navigation & Controllers](#navigation--controllers) +- [Collections & Tables](#collections--tables) +- [Media & Components](#media--components) + +--- + +## Layout & Constraints + + + +## Views & Controls + + + +## Navigation & Controllers + + + +## Collections & Tables + + + +## Media & Components + + diff --git a/README.md b/README.md index f252ffe..ae18fd9 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,17 @@ This is a repository of essential scripts written in Swift for Loverde Co. used ## Features - [x] Many usefull scripts extensions -- [x] `API` — typed async networking + multipart uploads. See **[Documentation/API.md](Documentation/API.md)** +- [x] `API` — typed async networking + multipart uploads +- [x] SwiftUI components (`LCENavigationView`) and UIKit-era helpers + +## Documentation + +| Guide | Covers | +| --- | --- | +| **[API.md](Documentation/API.md)** | `API` networking — requests, multipart uploads, client certificates, error handling, and why it beats a hand-rolled `URLSession` | +| **[Extensions.md](Documentation/Extensions.md)** | Foundation / value-type / string / collection / numeric / date / crypto extensions and the `LCEssentials` namespace | +| **[SwiftUI.md](Documentation/SwiftUI.md)** | SwiftUI components and `View` helpers | +| **[UIKit.md](Documentation/UIKit.md)** | Programmatic layout & constraints, view/control extensions, navigation, tables, and drop-in components | Installation @@ -80,6 +90,5 @@ Any question or doubts, please send thru email Daniel Arantes Loverde - [![Alt text](https://loverde.com.br/_signature/loverde_github_mail.gif "My Resume")](https://github.com/loverde-co/resume/) -[![Alt text](https://loverde.com.br/_signature/loverde_github_mail.gif "Loverde Co. Github")](https://github.com/loverde-co) Autor: Daniel Arantes Loverde