[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
This commit is contained in:
Daniel Arantes Loverde
2026-08-29 19:22:12 -03:00
parent 757d81615b
commit 705639b2f5
4 changed files with 124 additions and 2 deletions

View File

@@ -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
<!-- batch 2 -->
## Strings & Text
<!-- batch 3 -->
## Collections & Sequences
<!-- batch 4 -->
## Numbers & Geometry
<!-- batch 5 -->
## Date, Data & Files
<!-- batch 6 -->
## Encoding & Errors
<!-- batch 7 -->
## Crypto
<!-- batch 2 -->
## Core — the `LCEssentials` namespace
<!-- batch 7 -->

21
Documentation/SwiftUI.md Normal file
View File

@@ -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
<!-- batch 8 -->
## View helpers
<!-- batch 8 -->

40
Documentation/UIKit.md Normal file
View File

@@ -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
<!-- batch 9 -->
## Views & Controls
<!-- batch 10 -->
## Navigation & Controllers
<!-- batch 11 -->
## Collections & Tables
<!-- batch 12 -->
## Media & Components
<!-- batch 13 -->

View File

@@ -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 - <daniel@loverde.com.br>
[![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