"That's the one truth of anything anywhere, Apple documentation sucks" – @aazav

🍻 OnTap

Mission

Bring better documentation to SwiftUI developers – and do so through the power of open source.

How It Works

1. Edit code & submit PR

2. Your PR will be merged & website auto updated

3. Your Work is live!

How to Contribute

If you want to help document, open a PR with changes to the SwiftUI.swift file.

Documentation additions should be written directly in the comment blocks of the file using the standard Apple Markup Guide.

0 Open More issues

Closed

The relationship between the website and SwiftUI.swift main file is confusing

TL;DR

I would like to contribute, but I am not sure how exactly the SwiftUI.swift translates into the website.

In the SwiftUI.swift file, it seems like there is an extension for every single existing Swift API, with copied paste documentation from Apple's Documentation. Obviously, the point of this project is to replace them with better, detailed, step by step documentation. But not all the methods in SwiftUI.swift shows up on the website. Will they automatically show up once the documentation is edited, or is this a manual process?

By the way, should we break up the SwiftUI.swift file into subfiles, organizing by the SwiftUI component type? Because it is kind of painful when all the previews on Github doesn't work.

opened Feb 14, 2021 by jevonmao 5

Closed

Fix typo in README.md

opened Feb 15, 2021 by paxos 1

Closed

Correct the description of when you can access and mutate state prope…

…rties to align with what's in Apple's official documentation.

This is what it says in Apples documentation for @frozen @propertyWrapper struct State<Value>

You should only access a state property from inside the view’s body, or from methods called by it. For this reason, declare your state properties as private, to prevent clients of your view from accessing them. It is safe to mutate state properties from any thread.

I tried to rephrase the wording in Apples documentation as not to plagiarize, but I since Apple's documentation is already very concise, I feel like I just added fluff to something that was already clear. I'm open to suggestions regarding rephrasing.

This edit should clarify two points:

Accessing a state property is actually more strict than using the main thread. It should only be accessed from the call to the view's body.
Modifying state is actually completely permissive and can be accessed from any thread.

opened Feb 17, 2021 by roydaw 1

Closed

Very nice documentation, but expected to add MacOS support.

On macOS, some SwiftUI controls are displayed differently, and there are also some controls that can only be used on their respective platforms on macOS and iOS. I hope they can be more comprehensively reflected in the document.

such as:


#if os(macOS)
Settings {
Text("Settings here.")
}
#endif

English is not my native language; please excuse typing errors.

opened Feb 20, 2021 by Jinxiansen 1

Closed

Update README.md

opened Feb 1, 2021 by benjaminsage 0

Closed

Update pipeline to deprecate develop branch

The current CICD pipeline deploys to QA when a branch is merged into develop, and it deploys to production when you merge into main. This can create confusion about what branch to push to, along with increased friction with ensuring the develop/main branches stay in-sync.

This PR updates the pipeline so that a merge into main deploys to QA and a new semantic versioned tag deploys to production.

opened Feb 23, 2021 by a-moss 0

Open

Color changes

Added to our color picker example

opened Mar 3, 2021 by AlexFine 0

SwiftUI Documentation Project

"That's the one truth of anything anywhere, Apple documentation sucks" – @aazav

🍻 OnTap

Mission

How It Works

1. Edit code & submit PR

2. Your PR will be merged & website auto updated

3. Your Work is live!

How to Contribute

The relationship between the website and SwiftUI.swift main file is confusing

TL;DR

Fix typo in README.md

Correct the description of when you can access and mutate state prope…

Very nice documentation, but expected to add MacOS support.

Update README.md

Update pipeline to deprecate develop branch

Color changes

v1.0.5(Mar 2, 2021)

v1.0.4(Mar 1, 2021)

v1.0.3(Mar 1, 2021)

v1.0.2(Feb 28, 2021)

v1.0.1(Feb 23, 2021)

v1.0.0(Feb 19, 2021)

Related Repos

Category: Swift / Miscellaneous
Watchers: 9
Star: 141
Fork: 10
Last update: Feb 21, 2021