iOS Dev Weekly - iOS Dev Weekly - Issue 630

Did you know that DocC could create interactive tutorials? Let's showcase some. 🎭
 

iOS Dev Weekly

 
View on the Web    Archives

ISSUE 630  October 6th 2023

 
Comment

  Comment  

 

When Apple unveiled DocC two years ago, I don’t think anyone was too surprised to see it produce documentation from source code comment annotations with Markdown formatting.

But that wasn’t all DocC did, and it was a pleasant surprise when we learned it could use Markdown for both navigation structure and long-form documentation to accompany your generated API reference.

No one would have raised an eyebrow if that’s where the tool’s capabilities had stopped. But there was one big surprise left with it being able to produce fully interactive tutorials, like the Apple-authored ones they created to teach SwiftUI. It makes sense for Apple’s internal teams to all use the same tool rather than having a “documentation tool” and a “tutorial tool”, but I still didn’t expect it.

The slight downside is that those tutorials, while beautiful and easy to read, with screenshots that persist while the reader scrolls past multiple tutorial steps, take a long time to create. Would anyone outside Apple be willing to put the work in to make them?

So I’ve been idly keeping track every time I spot one in the wild, and while I’d not call them common, there are still plenty around, and I’d love to showcase a few for you today.

They’re even used to create training/workshop material, which I didn’t expect.

It’s fantastic to see people put time and effort into creating such high-quality tutorials. However, if you just looked through those and felt intimidated, remember that any documentation is better than nothing. Start with API reference documentation, go deeper with Markdown articles, and only consider adding the “icing on the cake” with a tutorial after that.

It’s great to see such a strong start from DocC. This comment is already too long, but I might write about how many packages we see adopting it in the Swift Package Index at some point soon. It’s more than we expected!

Dave Verwer  Permalink

 
 

  Sponsored Link  

 

Fast, AI-powered test automation with Testim Mobile

We’re built to help Agile teams manage and scale test automation. Author tests quickly, improve stability, and run using real and virtual devices. Learn more about Testim Mobile.

testim.io  Permalink

 
 
 

  Tools  

 

SwiftFormat Automation

I’ve written about my ideal setup for formatting and linting in Xcode. However, what I wished for doesn’t exist yet, so in the mean time, you should probably read Pranav Kasetti’s approach to getting part of the way there with what we have available today.

codewithkasetti.com  Permalink

 
 

  Code  

 

Swift Splash visionOS Sample Code

This new visionOS sample code from Apple looks excellent and is a great reminder that great documentation doesn’t have to be a slick, step-by-step tutorial. These larger sample code projects are great to see several aspects of the SDK work together. 👍

apple.com  Permalink

 

Changes to URL string parsing

I wasn’t aware of this change to URL, and while Toomas Vahter is correct that there’s an “important” warning on the official API docs, if Apple changes anything about URL parsing, that needs publicising.

Switching to the newer URL specification is a big deal, and in addition, the last sentence says that the new default (…) tries to encode invalid characters. This is a big deal.

Read this article and the API docs before checking nothing has broken in your apps.

augmentedcode.io  Permalink

 

Split your data easily and efficiently

There are so many useful little utilities and helpers in swift-algorithms (and in swift-collections, while we’re at it!), Here’s Danijela Vrzan to tell us all about one in particular. 👍

danijelavrzan.com  Permalink

 

An Interactive Intro to CRDTs

You might have heard mention of CRDTs over the last few years. I don’t remember if I first encountered them in one of Drew McCormack’s posts or by talking with Chris Eidhof, but they are a tempting solution to a long-standing and challenging problem. If they’re new to you, you could do far worse than reading and playing with the interactive demos in Jake Lazaroff’s latest post. Incredible work!

After that, it might be time to check out some of these packages.

jakelazaroff.com  Permalink

 
 

  Design  

 

SF Symbols 5

Seeing how far SF Symbols has come over the last few years is always fantastic, with hundreds of new symbols in every release (making more than 5,000 total!), colour, animation, and better localisation. It’s invaluable, and this year’s release is predictably even better, with better animations and more than 700 new glyphs.

The new app will get delivered through Software Update, or at least it did for me! So, manually installing this new version is unnecessary if you already have v4.

apple.com  Permalink

 
 

  Videos  

 

Swift TO

Why not start your weekend with a few recent Swift TO conference talks? Covering everything from how SwiftUI will destroy the publishing industry to how to build accessibility at the core of your development process, you’re sure to find something you’ll be interested in!

swiftconf.to  Permalink

 
 

  Books  

 

SwiftData by Example

Available as a PDF download or an online version that you can read for free, I’m confident Paul Hudson’s is the most comprehensive look at Apple’s new persistence framework there is. Incredibly, he published this book (effectively) simultaneously with the framework itself. That’s remarkable work. 🚀

gumroad.com  Permalink

 
 

  Jobs  

 

Senior iOS Developer @ Linearity GmbH – We’re an award-winning design software suite that simplifies the asset creation process. Linearity Curve creates precision vector assets & Linearity Move is an animation software that crafts breathtaking animations in seconds. We’re crafting together a new iOS team, reach out if you're Interested! – Remote (within European timezones)

Senior iOS Engineer @ Luma AI – We are a small AI research and product company working on new kinds of creative tools for 3D. Our mission is to democratize the 3D experience for all. iOS at Luma is at the center of the product universe. We are growing the iOS team from 1-4, please reach out if you're interested! – On-site (United States in CA) with some remote work (within US timezones)

 Permalink

 

Would you like to see your company’s open positions listed above? Post your job over on iOS Dev Jobs, and check out with a “Featured Listing”, and they’ll be here next week!

 Permalink

 
 

  And finally...  

 

“Come over and see your old pals when you’re done to talking to that guy.”

Great stories.

 Permalink

 
You received this email because you subscribed via the iOS Dev Weekly site.
We'll be sorry to see you go but you can unsubscribe instantly.
 
Shiny Development Ltd. Daresbury Innovation Centre Keckwick Lane Daresbury Cheshire WA4 4FS United Kingdom
 
 

 
 

RSS

 
©2023 iOS Dev Weekly | Privacy Policy | Mastodon | Twitter | Suggest a Link
 
Published with Curated

Older messages

iOS Dev Weekly - Issue 629

Friday, September 29, 2023

Should we be wishing for more custom UI in Settings.app? ⚙️ View on the Web Archives ISSUE 629 September 29th 2023 Comment I was chatting with a friend yesterday, and he asked what I thought of the new

iOS Dev Weekly - Issue 628

Friday, September 22, 2023

What does the future of testing in Swift look like? Find out, and give feedback! 📚 View on the Web Archives ISSUE 628 September 22nd 2023 Comment Happy new device day! Thanks also for all of the kind

iOS Dev Weekly - Issue 627

Sunday, September 17, 2023

No commentary today, but plenty of links! 🔗🔗🔗 View on the Web Archives ISSUE 627 September 15th 2023 Comment I hope you'll forgive me for skipping my commentary in today's issue. I've been

iOS Dev Weekly - Issue 626

Friday, September 8, 2023

Are all human eyes approximately the same distance apart? 🤷‍♂️ View on the Web Archives ISSUE 626 September 8th 2023 Comment I said last week that I don't expect any big Vision Pro news in

iOS Dev Weekly - Issue 625

Friday, September 1, 2023

Running all the tests is for pre-commit hooks and CI only! View on the Web Archives ISSUE 625 September 1st 2023 Comment I noticed Mike Gerasimenko's new XcodeSelectiveTesting library this week,

You Might Also Like

Daily Coding Problem: Problem #1646 [Medium]

Monday, December 23, 2024

Daily Coding Problem Good morning! Here's your coding interview problem for today. This problem was asked by Facebook. Write a function that rotates a list by k elements. For example, [1, 2, 3, 4,

GCP Newsletter #430

Monday, December 23, 2024

Welcome to issue #430 December 23rd, 2024 News Event Official Blog Calling all devs: Code the future of baseball with Google Cloud and MLB - Google Cloud and MLB are hosting a hackathon where

⏯️ Make a Holiday Guest Profile for Your Streaming Services — What Is Linux Mint?

Monday, December 23, 2024

Also: I Played the Worst Mobile Games So You Don't Have To, and More! How-To Geek Logo December 23, 2024 Did You Know The giant splashes of color that make poinsettias a popular holiday decoration

Ranked | The Most Satisfying vs. Most Reliable Car Brands in 2024 🚙

Monday, December 23, 2024

The most reliable car brands are rarely the most satisfying to own, according to recent Consumer Reports survey data. View Online | Subscribe | Download Our App Presented by: Find the megatrends

Bitcoin Enthusiasts Are Letting Altcoins Pass by

Monday, December 23, 2024

Top Tech Content sent at Noon! Boost Your Article on HackerNoon for $159.99! Read this email in your browser How are you, @newsletterest1? 🪐 What's happening in tech today, December 23, 2024? The

Last Minute Gifts from Walmart

Monday, December 23, 2024

ZDNET ZDNET Sponsored Message In Partnership with Walmart December 23, 2024 exclusive offer Walmart Last-minute gifts from Walmart Shop Now Walmart The tech you've been wishing for–at everyday low

15 ways AI saved me weeks of work in 2024

Monday, December 23, 2024

ZDNET's product of the year; Windows 11 24H2 bug list updated -- ZDNET ZDNET Tech Today - US December 23, 2024 AI applications on various devices. 15 surprising ways I used AI to save me weeks of

Distributed Locking: A Practical Guide

Monday, December 23, 2024

If you're wondering how and when distributed locking can be useful, here's the practical guide. I explained why distributed locking is needed in real-world scenarios. Explored how popular tools

⚡ THN Weekly Recap: Top Cybersecurity Threats, Tools and Tips

Monday, December 23, 2024

Your one-stop-source for last week's top cybersecurity headlines. The Hacker News THN Weekly Recap The online world never takes a break, and this week shows why. From ransomware creators being

⚙️ OpenA(G)I?

Monday, December 23, 2024

Plus: The Genesis Project ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌