Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jevonmao opened this issue Feb 15, 2021 · 5 comments

Comments

@jevonmao
Copy link

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.

@AlexFine
Copy link
Contributor

Hi! To your two points here:

How do I contribute?

Simply add your documentation to the SwiftUI.swift file above the method you'd like to document. Currently all methods in SwiftUI.swift should be on the website, however, we have had bugs where some don't show up. Do you see any specifically that aren't showing up?

Break up the SwiftUI.swift file?

Really good idea. Will investigate how difficult it is to actually do this. But smart.

@AlexFine
Copy link
Contributor

Lmk if this clarifies your questions. If so I'll close the issue.

@jevonmao
Copy link
Author

@AlexFine

  1. drawingGroup seems missing on the website, can you verify?

  2. For contributions, is there any area or category I should focus on? I want to focus on what needs help or is incomplete.

@AlexFine
Copy link
Contributor

drawingGroup seems missing on the website, can you verify?

Checkout: https://joinontap.com/view/drawinggroup%28opaque:colormode:%29

To be fair, it didn't come up when I searched it & I had to go to Views modifiers to find it. We'll improve our search.

is there any area I should focus on?

Great question. We really don't have a good "triage" system right now. We recommend starting with pages that you personally want to improve.

@jevonmao
Copy link
Author

Thank you very much! Great project you have right here.

denisenepraunig pushed a commit to denisenepraunig/Docs that referenced this issue Apr 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants