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.

Sign up for GitHub

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

Jump to bottom

Evaluate using DocC for iOS documentation #676

Closed
louwers opened this issue Jan 10, 2023 · 1 comment · Fixed by #867
Closed

Evaluate using DocC for iOS documentation #676

louwers opened this issue Jan 10, 2023 · 1 comment · Fixed by #867
Labels
documentation Improvements or additions to documentation iOS
Milestone
API documentation...

Comments

@louwers
Copy link
Collaborator

louwers commented Jan 10, 2023 •
edited
Loading

The Apple recommended way to provide documentation is DocC.

Worth taking a look at I think, especially since the iOS docs are in need of a refresh anyway.
@louwers louwers added documentation Improvements or additions to documentation iOS labels Jan 10, 2023
@louwers louwers mentioned this issue Jan 26, 2023
Closed
@birkskyum
Copy link
Member

We currently use the Jazzy pipeline for iOS docs generation.

A few years ago Apple released DocC as the officially recommended docs compiler. Streamlining docs in the ecosystem makes resources easier to consume for Apple developers. DocC initially lacked support for GitHub Pages, which is how we currently deploy our docs, but it's supported now. DocC initially only held support for Swift, but ObjC (which is the majority of our iOS SDK) has been added since XCode 14.

@louwers louwers changed the title Evaluate using DooC for iOS documentation Evaluate using DocC for iOS documentation Jan 26, 2023
@louwers louwers mentioned this issue Feb 27, 2023
Merged
@michaelkirk michaelkirk mentioned this issue Jun 2, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation iOS
Projects
None yet
Milestone
API documentation website updates iOS...
Development

Successfully merging a pull request may close this issue.

First step towards DocC iOS docs louwers/maplibre-native
2 participants
@louwers @birkskyum